diff --git a/src/Umbraco.Web.UI.Client/.editorconfig b/src/Umbraco.Web.UI.Client/.editorconfig new file mode 100644 index 0000000000..8a96204c8f --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.editorconfig @@ -0,0 +1,29 @@ +# EditorConfig helps developers define and maintain consistent +# coding styles between different editors and IDEs +# editorconfig.org + +root = true + + +[*] + +# Change these settings to your own preference +indent_style = tab +indent_size = 2 + +# We recommend you to keep these unchanged +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.md] +trim_trailing_whitespace = false + +[*.json] +indent_size = 2 + +[*.{html,js,md}] +block_comment_start = /** +block_comment = * +block_comment_end = */ diff --git a/src/Umbraco.Web.UI.Client/.env b/src/Umbraco.Web.UI.Client/.env new file mode 100644 index 0000000000..2863beab6e --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.env @@ -0,0 +1,6 @@ +# Copy this to .env.local and change what you want to test. +VITE_UMBRACO_USE_MSW=on # on = turns on MSW, off = disables all mock handlers +VITE_UMBRACO_API_URL=https://localhost:44339 +VITE_UMBRACO_INSTALL_STATUS=running # running or must-install or must-upgrade +VITE_MSW_QUIET=off # on = turns off MSW console logs, off = turns on MSW console logs +VITE_UMBRACO_EXTENSION_MOCKS=off # on = turns on extension mocks, off = turns off extension mocks diff --git a/src/Umbraco.Web.UI.Client/.env.e2e b/src/Umbraco.Web.UI.Client/.env.e2e new file mode 100644 index 0000000000..229671f683 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.env.e2e @@ -0,0 +1,3 @@ +# Copy this to .env.local and change what you want to test. +VITE_UMBRACO_USE_MSW=off # Playwright handles the mocking itself (using msw but it starts it up manually) +VITE_UMBRACO_API_URL= diff --git a/src/Umbraco.Web.UI.Client/.env.production b/src/Umbraco.Web.UI.Client/.env.production new file mode 100644 index 0000000000..bd90bc215e --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.env.production @@ -0,0 +1,2 @@ +VITE_UMBRACO_USE_MSW=off +VITE_UMBRACO_API_URL= diff --git a/src/Umbraco.Web.UI.Client/.env.staging b/src/Umbraco.Web.UI.Client/.env.staging new file mode 100644 index 0000000000..caf5203dd8 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.env.staging @@ -0,0 +1,2 @@ +VITE_UMBRACO_INSTALL_STATUS=running # running or must-install or must-upgrade +VITE_UMBRACO_USE_MSW=on diff --git a/src/Umbraco.Web.UI.Client/.github/CONTRIBUTING.md b/src/Umbraco.Web.UI.Client/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..3d02d924c6 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/CONTRIBUTING.md @@ -0,0 +1,239 @@ +# Contribution Guidelines + +## Thoughts, links, and questions + +In the high probability that you are porting something from angular JS then here are a few helpful tips for using Lit: + +Here is the LIT documentation and playground: [https://lit.dev](https://lit.dev) + +### How best to find what needs converting from the old backoffice? + +1. Navigate to [https://github.com/umbraco/Umbraco-CMS](https://github.com/umbraco/Umbraco-CMS) +2. Make sure you are on the `v14/dev` branch + +### What is the process of contribution? + +- Read the [README](README.md) to learn how to get the project up and running +- Find an issue marked as [community/up-for-grabs](https://github.com/umbraco/Umbraco.CMS.Backoffice/issues?q=is%3Aissue+is%3Aopen+label%3Acommunity%2Fup-for-grabs) - note that some are also marked [good first issue](https://github.com/umbraco/Umbraco.CMS.Backoffice/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) which indicates they are simple to get started on +- Umbraco HQ owns the Management API on the backend, so features can be worked on in the frontend only when there is an API, or otherwise if no API is required +- A contribution should be made in a fork of the repository +- Once a contribution is ready, a pull request should be made to this repository and HQ will assign a reviewer +- A pull request should always indicate what part of a feature it tries to solve, i.e. does it close the targeted issue (if any) or does the developer expect Umbraco HQ to take over + +## Contributing in general terms + +A lot of the UI has already been migrated to the new backoffice. Generally speaking, one would find a feature on the projects board, locate the UI in the old backoffice (v11 is fine), convert it to Lit components using the UI library, put the business logic into a store/service, write tests, and make a pull request. + +We are also very keen to receive contributions towards **documentation, unit testing, package development, accessibility, and just general testing of the UI.** + +## The Management API + +The management API is the colloquial term used to describe the new backoffice API. It is built as a .NET Web API, has a Swagger endpoint (/umbraco/swagger), and outputs an OpenAPI v3 schema, that the frontend consumes. + +The frontend has an API formatter that takes the OpenAPI schema file and converts it into a set of TypeScript classes and interfaces. + +### Caveats + +1. The backoffice can be run and tested against a real Umbraco instance by cloning down the `v14/dev` branch, but there are no guarantees about how well it works yet. + +**Current schema for API:** + +[https://raw.githubusercontent.com/umbraco/Umbraco-CMS/v13/dev/src/Umbraco.Cms.Api.Management/OpenApi.json](https://raw.githubusercontent.com/umbraco/Umbraco-CMS/v14/dev/src/Umbraco.Cms.Api.Management/OpenApi.json) + +**How to convert it:** + +- Run `npm run generate:api` + +## A contribution example + +### Example: Published Cache Status Dashboard + +![Published Status Dashboard](/.github/images/contributing/published-cache-status-dashboard.png) + +### Boilerplate (example using Lit) + +Links for Lit examples and documentation: + +- [https://lit.dev](https://lit.dev) +- [https://lit.dev/docs/](https://lit.dev/docs/) +- [https://lit.dev/playground/](https://lit.dev/playground/) + +### Functionality + +**HTML** + +The simplest approach is to copy over the HTML from the old backoffice into a new Lit element (check existing elements in the repository, e.g. if you are working with a dashboard, then check other dashboards, etc.). Once the HTML is inside the `render` method, it is often enough to simply replace `` elements with `` and replace a few of the attributes. In general, we try to build as much UI with Umbraco UI Library as possible. + +**Controller** + +The old AngularJS controllers will have to be converted into modern TypeScript and will have to use our new services and stores. We try to abstract as much away as possible, and mostly you will have to make API calls and let the rest of the system handle things like error handling and so on. In the case of this dashboard, we only have a few GET and POST requests. Looking at the new Management API, we find the PublishedCacheService, which is the new API controller to serve data to the dashboard. + +To make the first button work, which simply just requests a new status from the server, we must make a call to `PublishedCacheService.getPublishedCacheStatus()`. An additional thing here is to wrap that in a friendly function called `tryExecuteAndNotify`, which is something we make available to developers to automatically handle the responses coming from the server and additionally use the Notifications to notify of any errors: + +```typescript +import { tryExecuteAndNotify } from '@umbraco-cms/backoffice/resources'; +import { PublishedCacheService } from '@umbraco-cms/backoffice/external/backend-api'; + +private _getStatus() { + const { data: status } = await tryExecuteAndNotify(this, PublishedCacheService.getPublishedCacheStatus()); + + if (status) { + // we now have the status + console.log(status); + } +} +``` + +### State (buttons, etc) + +It is a good idea to make buttons indicate a loading state when awaiting an API call. All `` support the `.state` property, which you can set around API calls: + +```typescript +@state() +private _buttonState: UUIButtonState = undefined; + +private _getStatus() { + this._buttonState = 'waiting'; + + [...await...] + + this._buttonState = 'success'; +} +``` + +## Making the dashboard visible + +### Add to internal manifests + +All items are declared in a `manifests.ts` file, which is located in each section directory. + +To declare the Published Cache Status Dashboard as a new manifest, we need to add the section as a new json object that would look like this: + +```typescript +{ + type: 'dashboard', + alias: 'Umb.Dashboard.PublishedStatus', + name: 'Published Status Dashboard', + elementName: 'umb-dashboard-published-status', + element: () => import('./published-status/dashboard-published-status.element.js'), + weight: 200, + meta: { + label: 'Published Status', + pathname: 'published-status', + }, + conditions: [ + { + alias: 'Umb.Condition.SectionAlias', + match: 'Umb.Section.Settings', + }, + ], +}, +``` + +Let’s go through each of these properties… + +- Type: can be one of the following: + + - section - examples include: `Content`, `Media` + - dashboard - a view within a section. Examples include: the welcome dashboard + - propertyEditorUi + - editorView + - propertyAction + - tree + - editor + - treeItemAction + +- Alias: is the unique key used to identify this item. +- Name: is the human-readable name for this item. + +- ElementName: this is the customElementName declared on the element at the top of the file i.e + +```typescript +@customElement('umb-dashboard-published-status') +``` + +- Js: references a function call to import the file that the element is declared within + +- Weight: allows us to specify the order in which the dashboard will be displayed within the tabs bar + +- Meta: allows us to reference additional data - in our case, we can specify the label that is shown in the tabs bar and the pathname that will be displayed in the URL + +- Conditions: allows us to specify the conditions that must be met for the dashboard to be displayed. In our case, we are specifying that the dashboard will only be displayed within the Settings section + +## API mock handlers + +Running the app with `npm run dev`, you will quickly notice the API requests turn into 404 errors. To hit the API, we need to add a mock handler to define the endpoints that our dashboard will call. In the case of the Published Cache Status section, we have several calls to work through. Let’s start by looking at the call to retrieve the current status of the cache: + +![Published Status Dashboard](/.github/images/contributing/status-of-cache.png) + +From the existing functionality, we can see that this is a string message that is received as part of a `GET` request from the server. + +So to define this, we must first add a handler for the Published Status called `published-status.handlers.ts` within the mocks/domains folder. In this file we will have code that looks like the following: + +```typescript +const { rest } = window.MockServiceWorker; +import { umbracoPath } from '@umbraco-cms/backoffice/utils'; + +export const handlers = [ + rest.get(umbracoPath('/published-cache/status'), (_req, res, ctx) => { + return res( + // Respond with a 200 status code + ctx.status(200), + ctx.json( + 'Database cache is ok. ContentStore contains 1 item and has 1 generation and 0 snapshot. MediaStore contains 5 items and has 1 generation and 0 snapshot.', + ), + ); + }), +]; +``` + +This is defining the `GET` path that we will call through the resource: `/published-cache/status` + +It returns a `200 OK` response and a string value with the current “status” of the published cache for us to use within the element + +An example `POST` is similar. Let’s take the “Refresh status” button as an example: + +![Published Status Dashboard](/.github/images/contributing/refresh-status.png) + +From our existing functionality, we can see that this makes a `POST` call to the server to prompt a reload of the published cache. So we would add a new endpoint to the mock handler that would look like: + +```typescript +rest.post(umbracoPath('/published-cache/reload'), async (_req, res, ctx) => { + return res( + // Simulate a 1 second delay for the benefit of the UI + ctx.delay(1000) + // Respond with a 201 status code + ctx.status(201) + ); +}) +``` + +Which is defining a new `POST` endpoint that we can add to the core API fetcher using the path `/published-cache/reload`. + +This call returns a simple `OK` status code and no other object. + +## Storybook stories + +We try to make good Storybook stories for new components, which is a nice way to work with a component in an isolated state. Imagine you are working with a dialog on page 3 and have to navigate back to that every time you make a change - this is now eliminated with Storybook as you can just make a story that displays that step. Storybook can only show one component at a time, so it also helps us to isolate view logic into more and smaller components, which in turn are more testable. + +In-depth: [https://storybook.js.org/docs/web-components/get-started/introduction](https://storybook.js.org/docs/web-components/get-started/introduction) + +Reference: [https://ambitious-stone-0033b3603.1.azurestaticapps.net/](https://ambitious-stone-0033b3603.1.azurestaticapps.net/) + +- Locally: `npm run storybook` + +For Umbraco UI stories, please navigate to [https://uui.umbraco.com/](https://uui.umbraco.com/) + +## Testing + +There are two testing tools on the backoffice: unit testing and end-to-end testing. + +### Unit testing + +We are using a tool called Web Test Runner which spins up a bunch of browsers using Playwright with the well-known jasmine/chai syntax. It is expected that any new component/element has a test file named “<component>.test.ts”. It will automatically be picked up and there are a set of standard tests we apply to all components, which checks that they are registered correctly and they pass accessibility testing through Axe. + +Working with playwright: [https://playwright.dev/docs/intro](https://playwright.dev/docs/intro) + +## Putting it all together + +When we are finished with the dashboard we will hopefully have something akin to this [real-world example of the actual dashboard that was migrated](https://github.com/umbraco/Umbraco.CMS.Backoffice/tree/main/src/backoffice/settings/dashboards/published-status). diff --git a/src/Umbraco.Web.UI.Client/.github/ISSUE_TEMPLATE/01_bug_report.md b/src/Umbraco.Web.UI.Client/.github/ISSUE_TEMPLATE/01_bug_report.md new file mode 100644 index 0000000000..e48baa3152 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/ISSUE_TEMPLATE/01_bug_report.md @@ -0,0 +1,32 @@ +--- +name: "\U0001F41B Bug report" +about: Create a report to help us improve +title: "[BUG]: " +labels: type/bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/src/Umbraco.Web.UI.Client/.github/ISSUE_TEMPLATE/02_feature_request.md b/src/Umbraco.Web.UI.Client/.github/ISSUE_TEMPLATE/02_feature_request.md new file mode 100644 index 0000000000..d82f25d7c1 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/ISSUE_TEMPLATE/02_feature_request.md @@ -0,0 +1,20 @@ +--- +name: "✨ Feature request" +about: Suggest an idea for this project +title: '' +labels: type/feature +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/src/Umbraco.Web.UI.Client/.github/ISSUE_TEMPLATE/config.yml b/src/Umbraco.Web.UI.Client/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..999d82b31b --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: 💡 Features and ideas + url: https://github.com/umbraco/Umbraco.CMS.Backoffice/discussions/new?category=ideas + about: Start a new discussion when you have ideas or feature requests, eventually discussions can turn into plans. + - name: ❓ Support Question + url: https://our.umbraco.com + about: This issue tracker is NOT meant for support questions. If you have a question, please join us on the discussions board or Discord. diff --git a/src/Umbraco.Web.UI.Client/.github/LICENSE b/src/Umbraco.Web.UI.Client/.github/LICENSE new file mode 100644 index 0000000000..013e888f2e --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Umbraco HQ + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/src/Umbraco.Web.UI.Client/.github/README.md b/src/Umbraco.Web.UI.Client/.github/README.md new file mode 100644 index 0000000000..d9f0f72c16 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/README.md @@ -0,0 +1,76 @@ +# Umbraco.CMS.Backoffice (Bellissima) + +This is the working repository of the upcoming new Backoffice to Umbraco CMS. + +[![Build and test](https://github.com/umbraco/Umbraco.CMS.Backoffice/actions/workflows/build_test.yml/badge.svg)](https://github.com/umbraco/Umbraco.CMS.Backoffice/actions/workflows/build_test.yml) +[![Storybook](https://github.com/umbraco/Umbraco.CMS.Backoffice/actions/workflows/azure-static-web-apps-ambitious-stone-0033b3603.yml/badge.svg)](https://github.com/umbraco/Umbraco.CMS.Backoffice/actions/workflows/azure-static-web-apps-ambitious-stone-0033b3603.yml) +[![SonarCloud](https://sonarcloud.io/api/project_badges/measure?project=umbraco_Umbraco.CMS.Backoffice&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=umbraco_Umbraco.CMS.Backoffice) + +## Installation instructions + +1. Run `npm install` +2. Run `npm run dev` to launch Vite in dev mode + +### Environment variables + +The development environment supports `.env` files, so in order to set your own make a copy +of `.env` and name it `.env.local` and set the variables you need. + +As an example to show the installer instead of the login screen, set the following +in the `.env.local` file to indicate that Umbraco has not been installed: + +```bash +VITE_UMBRACO_INSTALL_STATUS=must-install +``` + +## Environments + +### Development + +The development environment is the default environment and is used when running `npm run dev`. All API calls are mocked and the Umbraco backoffice is served from the `src` folder. + +### Run against a local Umbraco instance + +If you have a local Umbraco instance running, you can use the development environment to run against it by overriding the API URL and bypassing the mock-service-worker in the frontend client. + +Create a `.env.local` file and set the following variables: + +```bash +VITE_UMBRACO_API_URL=https://localhost:44339 # This will be the URL to your Umbraco instance +VITE_UMBRACO_USE_MSW=off # Indicate that you want all API calls to bypass MSW (mock-service-worker) +``` + +Open this file in an editor: `src/Umbraco.Web.UI/appsettings.Development.json` and add this to the `Umbraco:CMS:Security` section to override the backoffice host: + +```json +"Umbraco": { + "CMS": { + "Security":{ + "BackOfficeHost": "http://localhost:5173", + "AuthorizeCallbackPathName": "/oauth_complete", + "AuthorizeCallbackLogoutPathName": "/logout", + "AuthorizeCallbackErrorPathName": "/error", + }, + }, +} +``` + +Now start the vite server: `npm run dev:server` in your backoffice folder and open the http://localhost:5173 URL in your browser. + +### Storybook + +Storybook is also being built and deployed automatically on the Main branch, including a preview URL on each pull request. See it in action on this [Azure Static Web App](https://ambitious-stone-0033b3603.1.azurestaticapps.net/). + +You can test the Storybook locally by running `npm run storybook`. This will start the Storybook server and open a browser window with the Storybook UI. + +Storybook is an excellent tool to test out UI components in isolation and to document them. It is also a great way to test the responsiveness and accessibility of the components. + +## Contributing + +We accept contributions to this project. However be aware that we are mainly working on a private backlog, so not everything will be immediately obvious. If you want to get started on contributing, please read the [contributing guidelines](./CONTRIBUTING.md). + +A list of issues can be found on the [Umbraco-CMS Issue Tracker](https://github.com/umbraco/Umbraco-CMS/issues). Many of them are marked as `community/up-for-grabs` which means they are up for grabs for anyone to work on. + +## Documentation + +The documentation can be found on [Umbraco Docs](https://docs.umbraco.com/umbraco-cms). diff --git a/src/Umbraco.Web.UI.Client/.github/RELEASE_INSTRUCTION.md b/src/Umbraco.Web.UI.Client/.github/RELEASE_INSTRUCTION.md new file mode 100644 index 0000000000..cfd5e491e7 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/RELEASE_INSTRUCTION.md @@ -0,0 +1,31 @@ +# Bellissima release instructions + + +## Build + +> _See internal documentation on the build/release workflow._ + + +## GitHub Release Notes + +To generate release notes on GitHub. + +- Go to the [**Releases** area](https://github.com/umbraco/Umbraco.CMS.Backoffice/releases) +- Press the [**"Draft a new release"** button](https://github.com/umbraco/Umbraco.CMS.Backoffice/releases/new) +- In the combobox for "Choose a tag", expand then select or enter the next version number, e.g. `v14.2.0` + - If the tag does not already exist, an option labelled "Create new tag: v14.2.0 on publish" will appear, select that option +- In the combobox for "Target: main", expand then select the release branch for the next version, e.g. `release/14.2` +- In the combobox for "Previous tag: auto": + - If the next release is an RC, then you can leave as `auto` + - Otherwise, select the previous stable version, e.g. `v14.1.1` +- Press the **"Generate release notes"** button, this will populate the main textarea +- Check the details, view in the "Preview" tab +- What type of release is this? + - If it's an RC, then check "Set as a pre-release" + - If it's stable, then check "Set as the latest release" +- Once you're happy with the contents and ready to save... + - If you need more time to review, press the **"Save draft"** button and you can come back to it later + - If you are ready to make the release notes public, then press **"Publish release"** button! :tada: + +> If you're curious about how the content is generated, take a look at the `release.yml` configuration: +> https://github.com/umbraco/Umbraco.CMS.Backoffice/blob/main/.github/release.yml diff --git a/src/Umbraco.Web.UI.Client/.github/dependabot.yml b/src/Umbraco.Web.UI.Client/.github/dependabot.yml new file mode 100644 index 0000000000..845aa7b637 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/dependabot.yml @@ -0,0 +1,14 @@ +version: 2 +updates: + + # Maintain dependencies for GitHub Actions + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + + # Maintain dependencies for npm + - package-ecosystem: "npm" + directory: "/" + schedule: + interval: "monthly" diff --git a/src/Umbraco.Web.UI.Client/.github/images/contributing/published-cache-status-dashboard.png b/src/Umbraco.Web.UI.Client/.github/images/contributing/published-cache-status-dashboard.png new file mode 100644 index 0000000000..dfe9d12413 Binary files /dev/null and b/src/Umbraco.Web.UI.Client/.github/images/contributing/published-cache-status-dashboard.png differ diff --git a/src/Umbraco.Web.UI.Client/.github/images/contributing/refresh-status.png b/src/Umbraco.Web.UI.Client/.github/images/contributing/refresh-status.png new file mode 100644 index 0000000000..4b1664c591 Binary files /dev/null and b/src/Umbraco.Web.UI.Client/.github/images/contributing/refresh-status.png differ diff --git a/src/Umbraco.Web.UI.Client/.github/images/contributing/status-of-cache.png b/src/Umbraco.Web.UI.Client/.github/images/contributing/status-of-cache.png new file mode 100644 index 0000000000..5815dfe933 Binary files /dev/null and b/src/Umbraco.Web.UI.Client/.github/images/contributing/status-of-cache.png differ diff --git a/src/Umbraco.Web.UI.Client/.github/localization_overview.md b/src/Umbraco.Web.UI.Client/.github/localization_overview.md new file mode 100644 index 0000000000..f69d559fcd --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/localization_overview.md @@ -0,0 +1,240 @@ + +# Help us with Localization! + +Localization of the New Backoffice is in full swing! +This is a work in process and here you can find the overview of all the sections that needs to be localized. We are also looking forward to see any contributions towards localization of the new Backoffice. + + +You may tick a section/subsection in the same PR as your changes, if it completes said section. + + +Before you start: +- Make sure you have read the [README](https://github.com/umbraco/Umbraco.CMS.Backoffice/blob/main/.github/README.md) and [Contributing Guidelines](https://github.com/umbraco/Umbraco.CMS.Backoffice/blob/main/.github/CONTRIBUTING.md). +- Please note some sections may already be partly or fully localized without it being reflected in the overview just yet. +- Get an understanding of how we do localization in the new Backoffice. The explanations can be found in the stories under **Localization** by running `npm run storybook`. Alternatively see the raw story file [localization.mdx](https://github.com/umbraco/Umbraco.CMS.Backoffice/blob/main/src/packages/core/localization/stories/localization.mdx) + + + +# Overview + - [Sections that needs to be localized](#sections) + - [Keys that needs to be localized](#keys) + +## Sections + +- [ ] [Header App](#header-app) +- [ ] [Content](#content) +- [ ] [Media](#media) +- [ ] [Settings](#settings) +- [ ] [Members](#members) +- [ ] [Packages](#packages) +- [ ] [Dictionary](#dictionary) +- [ ] [Users](#users) +- [ ] [Property Editors](#property-editor-ui-and-their-input) +- [ ] [Modals](#modals) +- [ ] [Misc](#misc) + + +### Subsections + +#### Header App +- [ ] Ensure all sections are localized +- [ ] Search +- [ ] Current user (Modal) + - [ ] Change password + +#### Content +- [ ] Dashboards + - [ ] Welcome + - [ ] Redirect Management +- [ ] Content / Document + - [ ] Section: Content + - [ ] Section: Info + - [ ] Section: Actions + +#### Media +- [ ] (To be continued) + +#### Settings +- [ ] Dashboards + - [x] Welcome / Settings + - [ ] Examine Management + - [ ] Models Builder + - [ ] Published Status + - [ ] Health Check + - [x] Profiling + - [x] Telemetry Data +- [ ] Document Type + - [ ] Section: Design + - [ ] Section: Structure + - [ ] Section: Settings + - [ ] Section: Templates +- [ ] Media Type +- [ ] Member Type +- [ ] Data Type + - [ ] Section: Details + - [ ] Section: Info +- [ ] Relation Types +- [ ] Log Viewer +- [x] Document Blueprints +- [ ] Languages +- [ ] Extensions +- [ ] Templates +- [ ] Partial Views +- [ ] Stylesheets + - [ ] Section: Rich Text Editor + - [ ] Section: Code +- [ ] Scripts + +#### Members +- [ ] Member Groups +- [ ] Members + +#### Packages +- [ ] Section: Installed +- [ ] Section: Created + - [ ] Package builder: "Create Package" + +#### Dictionary +- [ ] Everything within Dictionary + +#### Users +- [ ] Users +- [ ] User Groups +- [ ] Create user +- [ ] User Profiles + +#### Property Editor UI (and their inputs) +Ensure all property editors are properly localized. +(Some may be missing in this list / more to be added) +- [ ] Block Grid +- [ ] Block List +- [x] Checkbox List +- [ ] Collection View +- [ ] Color Picker +- [ ] Date Picker +- [x] Dropdown +- [ ] Eye Dropper +- [x] Icon Picker +- [ ] Image Cropper +- [ ] Image Crops Configuration +- [x] Label +- [ ] Markdown Editor +- [ ] Media Picker +- [ ] Member Group Picker +- [ ] Member Picker +- [ ] Multi URL Picker +- [ ] Multiple Text String +- [ ] Number (missing label) +- [ ] Number Range +- [ ] Order Direction +- [x] Radio Button List +- [ ] Slider (label) +- [ ] TextBox (label) +- [ ] TextArea +- [ ] TinyMCE +- [ ] Toggle +- [ ] Tree Picker + - [ ] StartNode + - [x] DynamicRoot +- [ ] Upload Field +- [ ] User Picker +- [ ] Value Type + +#### Modals +Ensure all modals are properly localized. +(Some may be missing in this list / more to be added) +- [ ] Code Editor +- [ ] Confirm +- [ ] Embedded Media +- [ ] Folder +- [ ] Icon Picker +- [ ] Link Picker +- [ ] Property Settings +- [ ] Section Picker +- [ ] Template +- [ ] Tree Picker +- [ ] Debug + +Rest of modals can be found: +- [ ] Umb***ModalName***ModalElement + + +#### Misc + +- [ ] Tree + - [ ] Tree Actions + - [ ] Recycle Bin +- [ ] Validator messages + + +## Keys + +Do you speak any of the following languages? +Then we need your help! With Bellissima we added new localization keys, and we still need them available in all our supported languages. + +- `bs-BS` - Bosnian (Bosnia and Herzegovina) +- `cs-CZ` - Czech (Czech Republic) +- `cy-GB` - Welsh (United Kingdom) +- `da-DK` - Danish (Denmark) +- `de-DE` - German (Germany) +- `en-GB` - English (United Kingdom) +- `es-ES` - Spanish (Spain) +- `fr-FR` - French (France) +- `he-IL` - Hebrew (Israel) +- `hr-HR` - Croatian (Croatia) +- `it-IT` - Italian (Italy) +- `ja-JP` - Japanese (Japan) +- `ko-KR` - Korean (Korea) +- `nb-NO` - Norwegian Bokmål (Norway) +- `nl-NL` - Dutch (Netherlands) +- `pl-PL` - Polish (Poland) +- `pt-BR` - Portuguese (Brazil) +- `ro-RO` - Romanian (Romania) +- `ru-RU` - Russian (Russia) +- `sv-SE` - Swedish (Sweden) +- `tr-TR` - Turkish (Turkey) +- `ua-UA` - Ukrainian (Ukraine) +- `zh-CN` - Chinese (China) +- `zh-TW` - Chinese (Taiwan) + +#### settingsDashboard +- documentationHeader +- documentationDescription +- communityHeader +- communityDescription +- trainingHeader +- trainingDescription +- supportHeader +- supportDescription +- videosHeader +- videosDescription +- getHelp +- getCertified +- goForum +- chatWithCommunity +- watchVideos + +- [ ] `bs-BS` - Bosnian (Bosnia and Herzegovina) +- [ ] `cs-CZ` - Czech (Czech Republic) +- [ ] `cy-GB` - Welsh (United Kingdom) +- [x] `da-DK` - Danish (Denmark) +- [ ] `de-DE` - German (Germany) +- [ ] `en-GB` - English (United Kingdom) +- [ ] `es-ES` - Spanish (Spain) +- [ ] `fr-FR` - French (France) +- [ ] `he-IL` - Hebrew (Israel) +- [ ] `hr-HR` - Croatian (Croatia) +- [ ] `it-IT` - Italian (Italy) +- [ ] `ja-JP` - Japanese (Japan) +- [ ] `ko-KR` - Korean (Korea) +- [ ] `nb-NO` - Norwegian Bokmål (Norway) +- [ ] `nl-NL` - Dutch (Netherlands) +- [ ] `pl-PL` - Polish (Poland) +- [ ] `pt-BR` - Portuguese (Brazil) +- [ ] `ro-RO` - Romanian (Romania) +- [ ] `ru-RU` - Russian (Russia) +- [ ] `sv-SE` - Swedish (Sweden) +- [ ] `tr-TR` - Turkish (Turkey) +- [ ] `ua-UA` - Ukrainian (Ukraine) +- [ ] `zh-CN` - Chinese (China) +- [ ] `zh-TW` - Chinese (Taiwan) diff --git a/src/Umbraco.Web.UI.Client/.github/pull_request_template b/src/Umbraco.Web.UI.Client/.github/pull_request_template new file mode 100644 index 0000000000..01c2c0fe8a --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/pull_request_template @@ -0,0 +1,30 @@ + + +## Description + + + +## Types of changes + + + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) +- [ ] Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets) + +## Motivation and context + + + +## How to test? + +## Screenshots (if appropriate) + +## Checklist + + + +- [ ] If my change requires a change to the documentation, I have updated the documentation in this pull request. +- [ ] I have read the **[CONTRIBUTING](<(https://github.com/umbraco/Umbraco.CMS.Backoffice/blob/main/.github/CONTRIBUTING.md)>)** document. +- [ ] I have added tests to cover my changes. diff --git a/src/Umbraco.Web.UI.Client/.github/release.yml b/src/Umbraco.Web.UI.Client/.github/release.yml new file mode 100644 index 0000000000..8cbd50695c --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/release.yml @@ -0,0 +1,40 @@ +# .github/release.yml + +changelog: + exclude: + labels: + - ignore-for-release + - duplicate + - wontfix + categories: + - title: 🙌 Notable Changes + labels: + - category/notable + - title: 💥 Breaking Changes + labels: + - category/breaking + - title: 🚀 New Features + labels: + - type/feature + - category/feature + - type/enhancement + - category/enhancement + - title: 🐛 Bug Fixes + labels: + - type/bug + - category/bug + - title: 📄 Documentation + labels: + - documentation + - title: 🏠 Internal + labels: + - internal + - title: 📦 Dependencies + labels: + - dependencies + - title: 🌈 A11Y + labels: + - accessibility + - title: Other Changes + labels: + - '*' diff --git a/src/Umbraco.Web.UI.Client/.github/workflows/azure-static-web-apps-ambitious-stone-0033b3603.yml b/src/Umbraco.Web.UI.Client/.github/workflows/azure-static-web-apps-ambitious-stone-0033b3603.yml new file mode 100644 index 0000000000..e618f4da80 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/workflows/azure-static-web-apps-ambitious-stone-0033b3603.yml @@ -0,0 +1,82 @@ +name: Storybook CI/CD + +on: + push: + branches: + - main + - release/* + - v*/dev + pull_request: + types: [opened, synchronize, reopened, closed] + branches: + - main + - release/* + - v*/dev + workflow_dispatch: + inputs: + issue_number: + type: number + description: 'Issue/PR Number to comment on' + required: false + +env: + NODE_OPTIONS: --max_old_space_size=16384 + +jobs: + build_and_deploy_job: + if: github.event_name != 'pull_request' || (github.event_name == 'pull_request' && github.event.action != 'closed' && contains(github.event.pull_request.labels.*.name, 'storybook')) + runs-on: ubuntu-latest + name: Build and Deploy Job + steps: + - uses: actions/checkout@v4 + with: + submodules: true + - name: Build And Deploy + id: builddeploy + uses: Azure/static-web-apps-deploy@v1 + with: + azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_AMBITIOUS_STONE_0033B3603 }} + repo_token: ${{ secrets.GITHUB_TOKEN }} # Used for Github integrations (i.e. PR comments) + action: 'upload' + ###### Repository/Build Configurations - These values can be configured to match your app requirements. ###### + # For more information regarding Static Web App workflow configurations, please visit: https://aka.ms/swaworkflowconfig + app_location: '/' # App source code path + app_build_command: 'npm run build-storybook' + api_location: '' # Api source code path - optional + output_location: '/storybook-static' # Built app content directory - optional + ###### End of Repository/Build Configurations ###### + - name: Comment on PR + # azure/static-web-apps-deploy doesn't support workflow_dispatch, so we need to manually comment on the PR + if: github.event_name == 'workflow_dispatch' && inputs.issue_number != null + uses: actions/github-script@v7 + env: + ISSUE_NUMBER: ${{ inputs.issue_number }} + SITE_URL: ${{ steps.builddeploy.outputs.static_web_app_url }} + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + github.rest.issues.addLabels({ + issue_number: process.env.ISSUE_NUMBER, + owner: context.repo.owner, + repo: context.repo.repo, + labels: ['storybook'] + }) + github.rest.issues.createComment({ + issue_number: process.env.ISSUE_NUMBER, + owner: context.repo.owner, + repo: context.repo.repo, + body: `Storybook is available at: ${process.env.SITE_URL}` + }) + + close_pull_request_job: + if: github.event_name == 'pull_request' && github.event.action == 'closed' && contains(github.event.pull_request.labels.*.name, 'storybook') + runs-on: ubuntu-latest + name: Close Pull Request Job + steps: + - name: Close Pull Request + id: closepullrequest + uses: Azure/static-web-apps-deploy@v1 + with: + app_location: '/' + azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_AMBITIOUS_STONE_0033B3603 }} + action: 'close' diff --git a/src/Umbraco.Web.UI.Client/.github/workflows/build_test.yml b/src/Umbraco.Web.UI.Client/.github/workflows/build_test.yml new file mode 100644 index 0000000000..8e70477ef8 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/workflows/build_test.yml @@ -0,0 +1,63 @@ +# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node +# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions + +name: Build and test + +on: + push: + branches: + - main + - release/* + - v*/dev + pull_request: + branches: + - main + - release/* + - v*/dev + + # Allows GitHub to use this workflow to validate the merge queue + merge_group: + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +env: + NODE_OPTIONS: --max_old_space_size=16384 + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version-file: .nvmrc + cache: npm + cache-dependency-path: ./package-lock.json + - run: npm ci --no-audit --no-fund --prefer-offline + - run: npm run lint:errors + - run: npm run build:for:cms + - run: npm run check:paths + - run: npm run generate:jsonschema:dist + + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version-file: .nvmrc + cache: npm + cache-dependency-path: ./package-lock.json + - run: npm ci --no-audit --no-fund --prefer-offline + - run: npx playwright install --with-deps + - run: npm test + - name: Upload Code Coverage reports + uses: actions/upload-artifact@v4 + if: always() + with: + name: code-coverage + path: coverage/ + retention-days: 30 diff --git a/src/Umbraco.Web.UI.Client/.github/workflows/codeql.yml b/src/Umbraco.Web.UI.Client/.github/workflows/codeql.yml new file mode 100644 index 0000000000..f3f3a37812 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/workflows/codeql.yml @@ -0,0 +1,61 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: 'CodeQL' + +on: + push: + branches: + - main + - release/* + - v*/dev + pull_request: + branches: + - main + - release/* + - v*/dev + schedule: + - cron: '33 2 * * 1' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: ['javascript'] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] + # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 diff --git a/src/Umbraco.Web.UI.Client/.github/workflows/dependency-review.yml b/src/Umbraco.Web.UI.Client/.github/workflows/dependency-review.yml new file mode 100644 index 0000000000..0d4a01360d --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/workflows/dependency-review.yml @@ -0,0 +1,20 @@ +# Dependency Review Action +# +# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging. +# +# Source repository: https://github.com/actions/dependency-review-action +# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement +name: 'Dependency Review' +on: [pull_request] + +permissions: + contents: read + +jobs: + dependency-review: + runs-on: ubuntu-latest + steps: + - name: 'Checkout Repository' + uses: actions/checkout@v4 + - name: 'Dependency Review' + uses: actions/dependency-review-action@v4 diff --git a/src/Umbraco.Web.UI.Client/.github/workflows/disabled/npm-publish-github-packages.yml b/src/Umbraco.Web.UI.Client/.github/workflows/disabled/npm-publish-github-packages.yml new file mode 100644 index 0000000000..f3aa140feb --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/workflows/disabled/npm-publish-github-packages.yml @@ -0,0 +1,82 @@ +# This workflow will publish the @umbraco-cms/backoffice package to npmjs.com +# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages +# The @umbraco-cms scope is owned by Umbraco HQ + +name: Node.js Package + +on: + push: + branches: [main] + paths: + - 'src/**' + - 'devops/publish/**' + - 'package.json' + - 'package-lock.json' + - 'tsconfig.json' + - 'staticwebapp.config.json' + - 'README.md' + workflow_dispatch: + inputs: + ref: + description: Branch or tag or SHA to publish + required: false + version: + description: 'Version to publish' + required: false + tag: + description: 'Tag to publish' + required: false + type: choice + options: + - 'next' + - 'latest' + +env: + NODE_OPTIONS: --max-old-space-size=16384 + +jobs: + build_publish: + name: Build and publish + runs-on: ubuntu-latest + concurrency: + group: npm-publish + cancel-in-progress: true + steps: + - uses: actions/checkout@v4 + with: + ref: ${{ inputs.ref }} + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: 'npm' + registry-url: https://registry.npmjs.org/ + scope: '@umbraco-cms' + - run: npm ci + - run: npm run build + - name: Calculate version + run: | + if [ -z "${{inputs.version}}" ]; then + echo "No version input, calculating version from package.json" + SHA_SHORT=$(echo $GITHUB_SHA | cut -c1-8) + VERSION=$(node -p "require('./package.json').version")-$SHA_SHORT + echo "Version: $VERSION" + echo "BACKOFFICE_VERSION=$VERSION" >> "$GITHUB_ENV" + else + echo "Version input found, using ${{inputs.version}}" + echo "BACKOFFICE_VERSION=${{inputs.version}}" >> "$GITHUB_ENV" + fi + - name: Publish + run: | + npm whoami + npm version $BACKOFFICE_VERSION --allow-same-version --no-git-tag-version + npm publish --tag $BACKOFFICE_NPM_TAG --access public + echo "### Published new version of @umbraco-cms/backoffice to npm! :rocket:" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "- Version: $BACKOFFICE_VERSION" >> $GITHUB_STEP_SUMMARY + echo "- Tag: $BACKOFFICE_NPM_TAG" >> $GITHUB_STEP_SUMMARY + echo "- Commit: $GITHUB_SHA" >> $GITHUB_STEP_SUMMARY + echo "- Commit message: $GITHUB_SHA_MESSAGE" >> $GITHUB_STEP_SUMMARY + echo "- Commit date: $GITHUB_SHA_DATE" >> $GITHUB_STEP_SUMMARY + env: + NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}} + BACKOFFICE_NPM_TAG: ${{ inputs.tag || 'next' }} diff --git a/src/Umbraco.Web.UI.Client/.github/workflows/pr-first-response.yml b/src/Umbraco.Web.UI.Client/.github/workflows/pr-first-response.yml new file mode 100644 index 0000000000..2b11c2d2d7 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.github/workflows/pr-first-response.yml @@ -0,0 +1,48 @@ +name: pr-first-response + +on: + pull_request_target: + types: [opened] + +jobs: + send-response: + runs-on: ubuntu-latest + permissions: + issues: write + pull-requests: write + steps: + - name: Fetch random comment 🗣️ and add it to the PR + uses: actions/github-script@v7 + with: + script: | + const response = await fetch('https://collaboratorsv2.euwest01.umbraco.io/umbraco/api/comments/PostComment', { + method: 'post', + body: JSON.stringify({ + repo: '${{ github.repository }}', + number: '${{ github.event.number }}', + actor: '${{ github.actor }}', + commentType: 'opened-pr-first-comment' + }), + headers: { + 'Authorization': 'Bearer ${{ secrets.OUR_BOT_API_TOKEN }}', + 'Content-Type': 'application/json' + } + }); + + try { + const data = await response.text(); + + if(response.status === 200 && data !== '') { + github.rest.issues.createComment({ + issue_number: context.issue.number, + owner: context.repo.owner, + repo: context.repo.repo, + body: data + }); + } else { + console.log("Status code did not indicate success:", response.status); + console.log("Returned data:", data); + } + } catch(error) { + console.log(error); + } diff --git a/src/Umbraco.Web.UI.Client/.gitignore b/src/Umbraco.Web.UI.Client/.gitignore new file mode 100644 index 0000000000..e9a0cf944d --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.gitignore @@ -0,0 +1,56 @@ +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* +lerna-debug.log* + +node_modules +dist +dist-cms +dist-ssr +/types +*.tsbuildinfo +*.local +*.tgz + +## testing +coverage/ + +# Editor directories and files +.vscode/* +!.vscode/extensions.json +!.vscode/*.code-snippets +!.vscode/settings.json +.idea +.DS_Store +*.suo +*.ntvs* +*.njsproj +*.sln +*.sw? + +# eslint +.eslintcache +test-results/ +playwright-report/ +playwright/.cache/ + +# storybook +storybook-static/ + +# API Docs +ui-api/ + +custom-elements.json + +# JSON for HTML Custom Data +# https://github.com/runem/web-component-analyzer#vscode +# https://github.com/microsoft/vscode-custom-data +vscode-html-custom-data.json +public/tinymce/* + +# Vite runtime files +vite.config.ts.timestamp-*.mjs diff --git a/src/Umbraco.Web.UI.Client/.madgerc b/src/Umbraco.Web.UI.Client/.madgerc new file mode 100644 index 0000000000..6cc1b8dacd --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.madgerc @@ -0,0 +1,9 @@ +{ + "tsConfig": "tsconfig.json", + "detectiveOptions": { + "ts": { + "skipTypeImports": true, + "skipAsyncImports": true + } + } +} diff --git a/src/Umbraco.Web.UI.Client/.npmrc b/src/Umbraco.Web.UI.Client/.npmrc new file mode 100644 index 0000000000..521a9f7c07 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.npmrc @@ -0,0 +1 @@ +legacy-peer-deps=true diff --git a/src/Umbraco.Web.UI.Client/.nvmrc b/src/Umbraco.Web.UI.Client/.nvmrc new file mode 100644 index 0000000000..209e3ef4b6 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.nvmrc @@ -0,0 +1 @@ +20 diff --git a/src/Umbraco.Web.UI.Client/.prettierignore b/src/Umbraco.Web.UI.Client/.prettierignore new file mode 100644 index 0000000000..cf2b798447 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.prettierignore @@ -0,0 +1,4 @@ +# Ignore auto-generated backend-api files +src/external/backend-api/src +src/packages/core/icon-registry/icons.ts +src/packages/core/icon-registry/icons diff --git a/src/Umbraco.Web.UI.Client/.prettierrc.json b/src/Umbraco.Web.UI.Client/.prettierrc.json new file mode 100644 index 0000000000..6080de481e --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.prettierrc.json @@ -0,0 +1,8 @@ +{ + "printWidth": 120, + "singleQuote": true, + "semi": true, + "bracketSpacing": true, + "bracketSameLine": true, + "useTabs": true +} diff --git a/src/Umbraco.Web.UI.Client/.sonarlint/connectedMode.json b/src/Umbraco.Web.UI.Client/.sonarlint/connectedMode.json new file mode 100644 index 0000000000..e9cefa00a5 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.sonarlint/connectedMode.json @@ -0,0 +1,4 @@ +{ + "sonarCloudOrganization": "umbraco", + "projectKey": "umbraco_Umbraco.CMS.Backoffice" +} \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/.storybook/main.ts b/src/Umbraco.Web.UI.Client/.storybook/main.ts new file mode 100644 index 0000000000..ca280343ba --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.storybook/main.ts @@ -0,0 +1,57 @@ +import { dirname, join } from 'path'; +import { StorybookConfig } from '@storybook/web-components-vite'; +import remarkGfm from 'remark-gfm'; + +const config: StorybookConfig = { + stories: ['../@(src|libs|apps|storybook)/**/*.mdx', '../@(src|libs|apps|storybook)/**/*.stories.@(js|jsx|ts|tsx)'], + addons: [ + getAbsolutePath('@storybook/addon-links'), + getAbsolutePath('@storybook/addon-essentials'), + getAbsolutePath('@storybook/addon-a11y'), + { + name: '@storybook/addon-docs', + options: { + mdxPluginOptions: { + mdxCompileOptions: { + remarkPlugins: [remarkGfm], + }, + }, + }, + }, + ], + framework: { + name: getAbsolutePath('@storybook/web-components-vite'), + options: {}, + }, + staticDirs: [ + '../public-assets', + '../public', + '../src/assets', + { + from: '../src/packages/core/icon-registry/icons', + to: 'assets/icons', + }, + ], + typescript: { + check: true, + }, + docs: {}, + managerHead(head, { configType }) { + const base = process.env.VITE_BASE_PATH || '/'; + const injections = [ + ``, // This decide how storybook's main frame visit stories + ]; + return configType === 'PRODUCTION' ? `${injections.join('')}${head}` : head; + }, + refs: { + uui: { + title: 'Umbraco UI Library', + url: 'https://62189360eeb21b003ab2f4ad-vfnpsanjps.chromatic.com/', + }, + }, +}; +export default config; + +function getAbsolutePath(value: string): any { + return dirname(require.resolve(join(value, 'package.json'))); +} diff --git a/src/Umbraco.Web.UI.Client/.storybook/manager.ts b/src/Umbraco.Web.UI.Client/.storybook/manager.ts new file mode 100644 index 0000000000..74d2e3170f --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.storybook/manager.ts @@ -0,0 +1,5 @@ +import { addons } from '@storybook/manager-api'; + +addons.setConfig({ + enableShortcuts: false, +}); diff --git a/src/Umbraco.Web.UI.Client/.storybook/package.json b/src/Umbraco.Web.UI.Client/.storybook/package.json new file mode 100644 index 0000000000..a0df0c8677 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.storybook/package.json @@ -0,0 +1,3 @@ +{ + "type": "commonjs" +} diff --git a/src/Umbraco.Web.UI.Client/.storybook/preview-body.html b/src/Umbraco.Web.UI.Client/.storybook/preview-body.html new file mode 100644 index 0000000000..9c5b8fea63 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.storybook/preview-body.html @@ -0,0 +1,4 @@ + diff --git a/src/Umbraco.Web.UI.Client/.storybook/preview-head.html b/src/Umbraco.Web.UI.Client/.storybook/preview-head.html new file mode 100644 index 0000000000..8a6c9e645c --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.storybook/preview-head.html @@ -0,0 +1,43 @@ + + + + diff --git a/src/Umbraco.Web.UI.Client/.storybook/preview.js b/src/Umbraco.Web.UI.Client/.storybook/preview.js new file mode 100644 index 0000000000..262cfe4e44 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.storybook/preview.js @@ -0,0 +1,148 @@ +import '@umbraco-ui/uui-css/dist/uui-css.css'; +import '../src/css/umb-css.css'; + +import 'element-internals-polyfill'; +import '@umbraco-ui/uui'; + +import { html } from 'lit'; +import { setCustomElements } from '@storybook/web-components'; + +import { startMockServiceWorker } from '../src/mocks'; + +import '../src/libs/controller-api/controller-host-provider.element'; +import { UmbModalManagerContext } from '../src/packages/core/modal'; +import { UmbDataTypeTreeStore } from '../src/packages/data-type/tree/data-type-tree.store'; +import { UmbDocumentDetailStore } from '../src/packages/documents/documents/repository/detail/document-detail.store'; +import { UmbDocumentTreeStore } from '../src/packages/documents/documents/tree/document-tree.store'; +import { UmbCurrentUserStore } from '../src/packages/user/current-user/repository/current-user.store'; +import { umbExtensionsRegistry } from '../src/packages/core/extension-registry'; +import { UmbIconRegistry } from '../src/packages/core/icon-registry/icon.registry'; +import { UmbLitElement } from '../src/packages/core/lit-element'; +import { umbLocalizationRegistry } from '../src/packages/core/localization'; +import customElementManifests from '../dist-cms/custom-elements.json'; +import icons from '../src/packages/core/icon-registry/icons'; + +import '../src/libs/context-api/provide/context-provider.element'; +import '../src/packages/core/components'; + +import { manifests as documentManifests } from '../src/packages/documents/manifests'; +import { manifests as localizationManifests } from '../src/packages/core/localization/manifests'; +import { UmbNotificationContext } from '../src/packages/core/notification'; + +// MSW +startMockServiceWorker({ serviceWorker: { url: (import.meta.env.VITE_BASE_PATH ?? '/') + 'mockServiceWorker.js' } }); + +class UmbStoryBookElement extends UmbLitElement { + _umbIconRegistry = new UmbIconRegistry(); + + constructor() { + super(); + this._umbIconRegistry.setIcons(icons); + this._umbIconRegistry.attach(this); + this._registerExtensions(documentManifests); + new UmbModalManagerContext(this); + new UmbCurrentUserStore(this); + new UmbNotificationContext(this); + + this._registerExtensions(localizationManifests); + umbLocalizationRegistry.loadLanguage('en-us'); // register default language + } + + _registerExtensions(manifests) { + manifests.forEach((manifest) => { + if (umbExtensionsRegistry.isRegistered(manifest.alias)) return; + umbExtensionsRegistry.register(manifest); + }); + } + + render() { + return html` + + `; + } +} + +customElements.define('umb-storybook', UmbStoryBookElement); + +const storybookProvider = (story) => html` ${story()} `; + +const dataTypeStoreProvider = (story) => html` + new UmbDataTypeTreeStore(host)} + >${story()} +`; + +const documentStoreProvider = (story) => html` + new UmbDocumentDetailStore(host)} + >${story()} +`; + +const documentTreeStoreProvider = (story) => html` + new UmbDocumentTreeStore(host)} + >${story()} +`; + +// Provide the MSW addon decorator globally +export const decorators = [documentStoreProvider, documentTreeStoreProvider, dataTypeStoreProvider, storybookProvider]; + +export const parameters = { + docs: { + source: { + excludeDecorators: true, + format: 'html', // see storybook docs for more info on this format https://storybook.js.org/docs/api/doc-blocks/doc-block-source#format + }, + }, + options: { + storySort: { + method: 'alphabetical', + includeNames: true, + order: [ + 'Guides', + [ + 'Getting started', + 'Extending the Backoffice', + [ + 'Intro', + 'Registration', + 'Header Apps', + 'Sections', + ['Intro', 'Sidebar', 'Views', '*'], + 'Entity Actions', + 'Workspaces', + ['Intro', 'Views', 'Actions', '*'], + 'Property Editors', + 'Repositories', + '*', + ], + '*', + ], + '*', + ], + }, + }, + controls: { + expanded: true, + matchers: { + color: /(background|color)$/i, + date: /Date$/, + }, + }, + backgrounds: { + default: 'Greyish', + values: [ + { + name: 'Greyish', + value: '#F3F3F5', + }, + { + name: 'White', + value: '#ffffff', + }, + ], + }, +}; + +setCustomElements(customElementManifests); +export const tags = ['autodocs']; diff --git a/src/Umbraco.Web.UI.Client/.vscode/extensions.json b/src/Umbraco.Web.UI.Client/.vscode/extensions.json new file mode 100644 index 0000000000..86a36f9dde --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.vscode/extensions.json @@ -0,0 +1,14 @@ +{ + "recommendations": [ + "gruntfuggly.todo-tree", + "formulahendry.auto-rename-tag", + "mikestead.dotenv", + "dbaeumer.vscode-eslint", + "runem.lit-plugin", + "esbenp.prettier-vscode", + "hbenl.vscode-test-explorer", + "vunguyentuan.vscode-css-variables", + "unifiedjs.vscode-mdx", + "editorconfig.editorconfig" + ] +} diff --git a/src/Umbraco.Web.UI.Client/.vscode/lit.code-snippets b/src/Umbraco.Web.UI.Client/.vscode/lit.code-snippets new file mode 100644 index 0000000000..4920d8011b --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.vscode/lit.code-snippets @@ -0,0 +1,30 @@ +{ + "UmbNewLitElement": { + "prefix": "new umb element", + "scope": "typescript", + "body": [ + "import { css, customElement, html } from '@umbraco-cms/backoffice/external/lit';", + "import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';", + "import { UmbTextStyles } from '@umbraco-cms/backoffice/style';", + "", + "@customElement('umb-${TM_FILENAME_BASE/(.*)\\..+$/$1/}')", + "export class Umb${TM_FILENAME_BASE/(.*)$/${1:/pascalcase}/}Element extends UmbLitElement {", + "\toverride render() {", + "\t\treturn html`$0`;", + "\t}", + "", + "\tstatic override readonly styles = [UmbTextStyles, css``];", + "}", + "", + "export { Umb${TM_FILENAME_BASE/(.*)$/${1:/pascalcase}/}Element as element };", + "", + "declare global {", + "\tinterface HTMLElementTagNameMap {", + "\t\t'umb-${TM_FILENAME_BASE/(.*)\\..+$/$1/}': Umb${TM_FILENAME_BASE/(.*)$/${1:/pascalcase}/}Element;", + "\t}", + "}", + "", + ], + "description": "Create a new Umbraco Lit element", + }, +} diff --git a/src/Umbraco.Web.UI.Client/.vscode/settings.json b/src/Umbraco.Web.UI.Client/.vscode/settings.json new file mode 100644 index 0000000000..2b3d645ee9 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/.vscode/settings.json @@ -0,0 +1,40 @@ +{ + "cssVariables.lookupFiles": ["node_modules/@umbraco-ui/uui-css/dist/custom-properties.css"], + "cSpell.words": [ + "backoffice", + "Backoffice", + "combobox", + "ctrls", + "devs", + "Dropcursor", + "Elementable", + "Gapcursor", + "iframes", + "invariantable", + "lucide", + "Niels", + "pickable", + "popovertarget", + "Registrator", + "Routable", + "stylesheet", + "svgs", + "templating", + "tinymce", + "tiptap", + "umbraco", + "Uncategorized", + "uninitialize", + "unprovide", + "unpublishing", + "variantable" + ], + "exportall.config.folderListener": [], + "exportall.config.relExclusion": [], + "conventionalCommits.scopes": ["partial views"], + "typescript.tsdk": "node_modules/typescript/lib", + "sonarlint.connectedMode.project": { + "connectionId": "umbraco", + "projectKey": "umbraco_Umbraco.CMS.Backoffice" + } +} diff --git a/src/Umbraco.Web.UI.Client/LICENSE b/src/Umbraco.Web.UI.Client/LICENSE new file mode 100644 index 0000000000..2819c99ca7 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/LICENSE @@ -0,0 +1,44 @@ +MIT License + +Copyright (c) 2024 Umbraco HQ + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +--- + +Third-party licenses + +--- + +Lucide License +ISC License + +Copyright (c) for portions of Lucide are held by Cole Bemis 2013-2022 as part of Feather (MIT). All other copyright (c) for Lucide are held by Lucide Contributors 2022. + +Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +--- + +Simple Icons +CC0 1.0 Universal license + +The person who associated a work with this deed has dedicated the work to the public domain by waiving all of his or her rights to the work worldwide under copyright law, including all related and neighboring rights, to the extent allowed by law. +You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission. diff --git a/src/Umbraco.Web.UI.Client/README.md b/src/Umbraco.Web.UI.Client/README.md new file mode 100644 index 0000000000..1404fba49c --- /dev/null +++ b/src/Umbraco.Web.UI.Client/README.md @@ -0,0 +1,172 @@ +# @umbraco-cms/backoffice + +This package contains the types for the Umbraco Backoffice. + +## Installation + +```bash +npm install -D @umbraco-cms/backoffice +``` + +## Usage + +### Vanilla JavaScript + +Create an umbraco-package.json file in the root of your package. + +```json +{ + "name": "My.Package", + "version": "0.1.0", + "extensions": [ + { + "type": "dashboard", + "alias": "my.custom.dashboard", + "name": "My Dashboard", + "js": "/App_Plugins/MyPackage/dashboard.js", + "weight": -1, + "meta": { + "label": "My Dashboard", + "pathname": "my-dashboard" + }, + "conditions": [ + { + "alias": "Umb.Condition.SectionAlias", + "match": "Umb.Section.Content" + } + ] + } + ] +} +``` + +Then create a dashboard.js file the same folder. + +```javascript +import { UmbElementMixin } from '@umbraco-cms/backoffice/element-api'; +import { UMB_NOTIFICATION_CONTEXT } from '@umbraco-cms/backoffice/notification'; + +const template = document.createElement('template'); +template.innerHTML = ` + + + +

Welcome to my dashboard

+

Example of vanilla JS code

+ + + +`; + +export default class MyDashboardElement extends UmbElementMixin(HTMLElement) { + /** @type {import('@umbraco-cms/backoffice/notification').UmbNotificationContext} */ + #notificationContext; + + constructor() { + super(); + this.attachShadow({ mode: 'open' }); + this.shadowRoot.appendChild(template.content.cloneNode(true)); + + this.shadowRoot.getElementById('clickMe').addEventListener('click', this.onClick.bind(this)); + + this.consumeContext(UMB_NOTIFICATION_CONTEXT, (_instance) => { + this.#notificationContext = _instance; + }); + } + + onClick = () => { + this.#notificationContext?.peek('positive', { data: { headline: 'Hello' } }); + }; +} + +customElements.define('my-custom-dashboard', MyDashboardElement); +``` + +### TypeScript with Lit + +First install Lit and Vite. This command will create a new folder called `my-package` which will have the Vite tooling and Lit for WebComponent development setup. + +```bash +npm create vite@latest -- --template lit-ts my-package +``` + +Go to the new folder and install the backoffice package. + +```bash +cd my-package +npm install -D @umbraco-cms/backoffice +``` + +Then go to the element located in `src/my-element.ts` and replace it with the following code. + +```typescript +// src/my-element.ts +import { LitElement, html, customElement } from '@umbraco-cms/backoffice/external/lit'; +import { UmbElementMixin } from '@umbraco-cms/backoffice/element-api'; +import { UmbNotificationContext, UMB_NOTIFICATION_CONTEXT } from '@umbraco-cms/backoffice/notification'; + +@customElement('my-element') +export default class MyElement extends UmbElementMixin(LitElement) { + private _notificationContext?: UmbNotificationContext; + + constructor() { + super(); + this.consumeContext(UMB_NOTIFICATION_CONTEXT, (_instance) => { + this._notificationContext = _instance; + }); + } + + onClick() { + this._notificationContext?.peek('positive', { data: { message: '#h5yr' } }); + } + + override render() { + return html` + +

A TypeScript Lit Dashboard

+ this.onClick()}> + + `; + } +} + +declare global { + interface HTMLElementTagNameMap { + 'my-element': MyElement; + } +} +``` + +Finally add an umbraco-package.json file in the root of your package folder `my-package`. + +```json +{ + "name": "My.Package", + "version": "0.1.0", + "extensions": [ + { + "type": "dashboard", + "alias": "my.custom.dashboard", + "name": "My Dashboard", + "js": "/App_Plugins/MyPackage/dist/my-package.js", + "weight": -1, + "meta": { + "label": "My Dashboard", + "pathname": "my-dashboard" + }, + "conditions": [ + { + "alias": "Umb.Condition.SectionAlias", + "match": "Umb.Section.Content" + } + ] + } + ] +} +``` diff --git a/src/Umbraco.Web.UI.Client/devops/build/check-path-length.js b/src/Umbraco.Web.UI.Client/devops/build/check-path-length.js new file mode 100644 index 0000000000..182964f3be --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/build/check-path-length.js @@ -0,0 +1,80 @@ +import { readdirSync, statSync } from 'fs'; +import { join } from 'path'; + +const PROJECT_DIR = process.argv[2] ?? '.'; +const MAX_PATH_LENGTH = process.argv[3] ?? 140; +const IS_CI = process.env.CI === 'true'; +const IS_AZURE_PIPELINES = process.env.TF_BUILD === 'true'; +const IS_GITHUB_ACTIONS = process.env.GITHUB_ACTIONS === 'true'; +const FILE_PATH_COLOR = '\x1b[36m%s\x1b[0m'; +const ERROR_COLOR = '\x1b[31m%s\x1b[0m'; +const SUCCESS_COLOR = '\x1b[32m%s\x1b[0m'; +const processExitCode = 1; // Default to 1 to fail the build, 0 to just log the issues + +console.log(`Checking path length in ${PROJECT_DIR} for paths exceeding ${MAX_PATH_LENGTH}...`); +console.log('CI detected:', IS_CI); + +console.log('\n-----------------------------------'); +console.log('Results:'); +console.log('-----------------------------------\n'); + +const hasError = checkPathLength(PROJECT_DIR); + +if (hasError) { + console.log('\n-----------------------------------'); + console.log(ERROR_COLOR, 'Path length check failed'); + console.log('-----------------------------------\n'); + if (IS_CI && processExitCode) { + process.exit(processExitCode); + } +} else { + console.log('\n-----------------------------------'); + console.log(SUCCESS_COLOR, 'Path length check passed'); + console.log('-----------------------------------\n'); +} + +// Functions + +/** + * Recursively check the path length of all files in a directory. + * @param {string} dir - The directory to check for path lengths + * @returns {boolean} + */ +function checkPathLength(dir) { + const files = readdirSync(dir); + let hasError = false; + + files.forEach(file => { + const filePath = join(dir, file); + if (filePath.length > MAX_PATH_LENGTH) { + hasError = true; + + if (IS_AZURE_PIPELINES) { + console.error(`##vso[task.logissue type=error;sourcepath=${mapFileToSourcePath(filePath)};]Path exceeds maximum length of ${MAX_PATH_LENGTH} characters: ${filePath} with ${filePath.length} characters`); + } else if (IS_GITHUB_ACTIONS) { + console.error(`::error file=${mapFileToSourcePath(filePath)},title=Path exceeds ${MAX_PATH_LENGTH} characters::Paths should not be longer than ${MAX_PATH_LENGTH} characters to support WIN32 systems. The file ${filePath} exceeds that with ${filePath.length - MAX_PATH_LENGTH} characters.`); + } else { + console.error(FILE_PATH_COLOR, mapFileToSourcePath(filePath), '(exceeds by', filePath.length - MAX_PATH_LENGTH, 'chars)'); + } + } + + if (statSync(filePath).isDirectory()) { + const subHasError = checkPathLength(filePath); + if (subHasError) { + hasError = true; + } + } + }); + + return hasError; +} + +/** + * Maps a file path to a source path for CI logs. + * @remark This might not always work as expected, especially on bundled files, but it's a best effort to map the file path to a source path. + * @param {string} file - The file path to map to a source path + * @returns {string} + */ +function mapFileToSourcePath(file) { + return file.replace(PROJECT_DIR, 'src').replace('.js', '.ts'); +} diff --git a/src/Umbraco.Web.UI.Client/devops/build/copy-to-cms.js b/src/Umbraco.Web.UI.Client/devops/build/copy-to-cms.js new file mode 100644 index 0000000000..7c2902296f --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/build/copy-to-cms.js @@ -0,0 +1,9 @@ +import { cpSync, rmSync } from 'fs'; + +const srcDir = './dist-cms'; +const outputDir = '../Umbraco.Cms.StaticAssets/wwwroot/umbraco/backoffice'; + +rmSync(outputDir, { recursive: true, force: true }); +cpSync(srcDir, outputDir, { recursive: true }); + +console.log('--- Copied build output to CMS successfully. ---'); diff --git a/src/Umbraco.Web.UI.Client/devops/build/create-umbraco-package.js b/src/Umbraco.Web.UI.Client/devops/build/create-umbraco-package.js new file mode 100644 index 0000000000..889550ba51 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/build/create-umbraco-package.js @@ -0,0 +1,23 @@ +import { createImportMap } from "../importmap/index.js"; +import { writeFileSync, rmSync } from "fs"; +import { packageJsonName, packageJsonVersion } from "../package/index.js"; + +const srcDir = './dist-cms'; +const outputModuleList = `${srcDir}/umbraco-package.json`; +const importmap = createImportMap({ rootDir: '/umbraco/backoffice', additionalImports: {} }); + +const umbracoPackageJson = { + name: packageJsonName, + version: packageJsonVersion, + extensions: [], + importmap +}; + +try { + rmSync(outputModuleList, { force: true }); + writeFileSync(outputModuleList, JSON.stringify(umbracoPackageJson)); + console.log(`Wrote manifest to ${outputModuleList}`); +} catch (e) { + console.error(`Failed to write manifest to ${outputModuleList}`, e); + process.exit(1); +} diff --git a/src/Umbraco.Web.UI.Client/devops/build/global-types.js b/src/Umbraco.Web.UI.Client/devops/build/global-types.js new file mode 100644 index 0000000000..88d16199b6 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/build/global-types.js @@ -0,0 +1,25 @@ +import { createImportMap } from '../importmap/index.js'; +import { writeFileWithDir } from '../utils/index.js'; + +const tsPath = './dist-cms/packages/extension-types/index.d.ts'; + +const importmap = createImportMap({ + rootDir: './src', + replaceModuleExtensions: true, +}); + +const paths = Object.keys(importmap.imports); + +const content = ` +${paths.map((path) => `import '${path}';`).join('\n')} +`; + +writeFileWithDir(tsPath, content, (err) => { + if (err) { + // eslint-disable-next-line no-undef + console.log(err); + } + + // eslint-disable-next-line no-undef + console.log(`global-types file generated`); +}); diff --git a/src/Umbraco.Web.UI.Client/devops/eslint/rules/bad-type-import.cjs b/src/Umbraco.Web.UI.Client/devops/eslint/rules/bad-type-import.cjs new file mode 100644 index 0000000000..eebdca6c75 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/eslint/rules/bad-type-import.cjs @@ -0,0 +1,31 @@ + /** @type {import('eslint').Rule.RuleModule} */ +module.exports = { + meta: { + type: 'problem', + docs: { + description: 'Ensures the use of the `import type` operator from the `src/core/models/index.ts` file.', + category: 'Best Practices', + recommended: true, + }, + fixable: 'code', + schema: [], + }, + create: function (context) { + return { + ImportDeclaration: function (node) { + if ( + node.source.parent.importKind !== 'type' && + (node.source.value.endsWith('/models') || node.source.value === 'router-slot/model') + ) { + const sourceCode = context.getSourceCode(); + const nodeSource = sourceCode.getText(node); + context.report({ + node, + message: 'Use `import type` instead of `import`.', + fix: (fixer) => fixer.replaceText(node, nodeSource.replace('import', 'import type')), + }); + } + }, + }; + }, +}; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/devops/eslint/rules/enforce-element-suffix-on-element-class-name.cjs b/src/Umbraco.Web.UI.Client/devops/eslint/rules/enforce-element-suffix-on-element-class-name.cjs new file mode 100644 index 0000000000..865fcab738 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/eslint/rules/enforce-element-suffix-on-element-class-name.cjs @@ -0,0 +1,31 @@ +/** @type {import('eslint').Rule.RuleModule} */ +module.exports = { + meta: { + type: 'suggestion', + docs: { + description: 'Enforce Element class name to end with "Element".', + category: 'Naming', + recommended: true, + }, + schema: [], + }, + create: function (context) { + return { + ClassDeclaration(node) { + // check if the class extends HTMLElement, LitElement, or UmbLitElement + const isExtendingElement = + node.superClass && ['HTMLElement', 'LitElement', 'UmbLitElement'].includes(node.superClass.name); + // check if the class name ends with 'Element' + const isClassNameValid = node.id.name.endsWith('Element'); + + if (isExtendingElement && !isClassNameValid) { + context.report({ + node, + message: "Element class name should end with 'Element'.", + // There us no fixer on purpose because it's not safe to rename the class. We want to do that trough the refactoring tool. + }); + } + }, + }; + }, +}; diff --git a/src/Umbraco.Web.UI.Client/devops/eslint/rules/enforce-umb-prefix-on-element-name.cjs b/src/Umbraco.Web.UI.Client/devops/eslint/rules/enforce-umb-prefix-on-element-name.cjs new file mode 100644 index 0000000000..5db023e932 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/eslint/rules/enforce-umb-prefix-on-element-name.cjs @@ -0,0 +1,41 @@ +/** @type {import('eslint').Rule.RuleModule} */ +module.exports = { + meta: { + type: 'suggestion', + docs: { + description: 'Enforce Custom Element names to start with "umb-".', + category: 'Naming', + recommended: true, + }, + schema: [], + }, + create: function (context) { + return { + CallExpression(node) { + // check if the expression is @customElement decorator + const isCustomElementDecorator = + node.callee.type === 'Identifier' && + node.callee.name === 'customElement' && + node.arguments.length === 1 && + node.arguments[0].type === 'Literal' && + typeof node.arguments[0].value === 'string'; + + if (isCustomElementDecorator) { + const elementName = node.arguments[0].value; + + // check if the element name starts with 'umb-', or 'test-', to be allow tests to have custom elements: + const isElementNameValid = elementName.startsWith('umb-') ? true : elementName.startsWith('test-'); + + if (!isElementNameValid) { + context.report({ + node, + message: 'Custom Element name should start with "umb-".', + // There is no fixer on purpose because it's not safe to automatically rename the element name. + // Renaming should be done manually with consideration of potential impacts. + }); + } + } + }, + }; + }, +}; diff --git a/src/Umbraco.Web.UI.Client/devops/eslint/rules/enforce-umbraco-external-imports.cjs b/src/Umbraco.Web.UI.Client/devops/eslint/rules/enforce-umbraco-external-imports.cjs new file mode 100644 index 0000000000..6484da2b82 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/eslint/rules/enforce-umbraco-external-imports.cjs @@ -0,0 +1,50 @@ +/** @type {import('eslint').Rule.RuleModule}*/ +module.exports = { + meta: { + type: 'problem', + docs: { + description: + 'Ensures that the application strictly uses node_modules imports from `@umbraco-cms/backoffice/external`. This is needed to run the application in the browser.', + recommended: true, + }, + fixable: 'code', + schema: { + type: 'array', + minItems: 0, + maxItems: 1, + items: [ + { + type: 'object', + properties: { + exceptions: { type: 'array' }, + }, + additionalProperties: false, + }, + ], + }, + }, + create: (context) => { + return { + ImportDeclaration: (node) => { + const { source } = node; + const { value } = source; + + const options = context.options[0] || {}; + const exceptions = options.exceptions || []; + + // If import starts with any of the following, then it's allowed + if (exceptions.some((v) => value.startsWith(v))) { + return; + } + + context.report({ + node, + message: + 'node_modules imports should be proxied through `@umbraco-cms/backoffice/external`. Please create it if it does not exist.', + fix: (fixer) => + fixer.replaceText(source, `'@umbraco-cms/backoffice/external${value.startsWith('/') ? '' : '/'}${value}'`), + }); + }, + }; + }, +}; diff --git a/src/Umbraco.Web.UI.Client/devops/eslint/rules/ensure-relative-import-use-js-extension.cjs b/src/Umbraco.Web.UI.Client/devops/eslint/rules/ensure-relative-import-use-js-extension.cjs new file mode 100644 index 0000000000..ee53dab5fc --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/eslint/rules/ensure-relative-import-use-js-extension.cjs @@ -0,0 +1,91 @@ +/** @type {import('eslint').Rule.RuleModule}*/ +module.exports = { + meta: { + type: 'problem', + docs: { + description: 'Ensures relative imports use the ".js" file extension.', + category: 'Best Practices', + recommended: true, + }, + fixable: 'code', + schema: [], + }, + create: (context) => { + function correctImport(value) { + if (value === '.') { + return './index.js'; + } + + if ( + value && + value.startsWith('.') && + !value.endsWith('.js') && + !value.endsWith('.css') && + !value.endsWith('.json') && + !value.endsWith('.svg') && + !value.endsWith('.jpg') && + !value.endsWith('.png') + ) { + return (value.endsWith('/') ? value + 'index' : value) + '.js'; + } + + return null; + } + + return { + ImportDeclaration: (node) => { + const { source } = node; + const { value } = source; + + const fixedValue = correctImport(value); + if (fixedValue) { + context.report({ + node, + message: 'Relative imports should use the ".js" file extension.', + fix: (fixer) => fixer.replaceText(source, `'${fixedValue}'`), + }); + } + }, + ImportExpression: (node) => { + const { source } = node; + const { value } = source; + + const fixedSource = correctImport(value); + if (fixedSource) { + context.report({ + node: source, + message: 'Relative imports should use the ".js" file extension.', + fix: (fixer) => fixer.replaceText(source, `'${fixedSource}'`), + }); + } + }, + ExportAllDeclaration: (node) => { + const { source } = node; + const { value } = source; + + const fixedSource = correctImport(value); + if (fixedSource) { + context.report({ + node: source, + message: 'Relative exports should use the ".js" file extension.', + fix: (fixer) => fixer.replaceText(source, `'${fixedSource}'`), + }); + } + }, + ExportNamedDeclaration: (node) => { + const { source } = node; + if (!source) return; + const { value } = source; + + const fixedSource = correctImport(value); + if (fixedSource) { + context.report({ + node: source, + message: 'Relative exports should use the ".js" file extension.', + fix: (fixer) => fixer.replaceText(source, `'${fixedSource}'`), + }); + } + }, + }; + }, +}; diff --git a/src/Umbraco.Web.UI.Client/devops/eslint/rules/exported-string-constant-naming.cjs b/src/Umbraco.Web.UI.Client/devops/eslint/rules/exported-string-constant-naming.cjs new file mode 100644 index 0000000000..8118a54ab1 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/eslint/rules/exported-string-constant-naming.cjs @@ -0,0 +1,54 @@ +/** @type {import('eslint').Rule.RuleModule}*/ +module.exports = { + meta: { + type: 'problem', + docs: { + description: + 'Ensure all exported string constants should be in uppercase with words separated by underscores and prefixed with UMB_', + }, + schema: [ + { + type: 'object', + properties: { + excludedFileNames: { + type: 'array', + items: { + type: 'string', + }, + }, + }, + additionalProperties: false, + }, + ], + }, + create: function (context) { + const excludedFileNames = context.options[0]?.excludedFileNames || []; + return { + ExportNamedDeclaration(node) { + const fileName = context.filename; + + if (excludedFileNames.some((excludedFileName) => fileName.includes(excludedFileName))) { + // Skip the rule check for files in the excluded list + return; + } + + if (node.declaration && node.declaration.type === 'VariableDeclaration') { + const declaration = node.declaration.declarations[0]; + const { id, init } = declaration; + + if (id && id.type === 'Identifier' && init && init.type === 'Literal' && typeof init.value === 'string') { + const isValidName = /^[A-Z]+(_[A-Z]+)*$/.test(id.name); + + if (!isValidName || !id.name.startsWith('UMB_')) { + context.report({ + node: id, + message: + 'Exported string constant should be in uppercase with words separated by underscores and prefixed with UMB_', + }); + } + } + } + }, + }; + }, +}; diff --git a/src/Umbraco.Web.UI.Client/devops/eslint/rules/no-direct-api-import.cjs b/src/Umbraco.Web.UI.Client/devops/eslint/rules/no-direct-api-import.cjs new file mode 100644 index 0000000000..9f3a3912dc --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/eslint/rules/no-direct-api-import.cjs @@ -0,0 +1,42 @@ +/** @type {import('eslint').Rule.RuleModule} */ +module.exports = { + meta: { + docs: { + description: + 'Ensures that any API resources from the `@umbraco-cms/backoffice/external/backend-api` module are not used directly. Instead you should use the `tryExecuteAndNotify` function from the `@umbraco-cms/backoffice/resources` module.', + category: 'Best Practices', + recommended: true, + }, + fixable: 'code', + schema: [], + }, + create: function (context) { + return { + // If methods called on *Service classes are not already wrapped with `await tryExecuteAndNotify()`, then we should suggest to wrap them. + CallExpression: function (node) { + if ( + node.callee.type === 'MemberExpression' && + node.callee.object.type === 'Identifier' && + node.callee.object.name.endsWith('Service') && + node.callee.property.type === 'Identifier' && + node.callee.property.name !== 'constructor' + ) { + const hasTryExecuteAndNotify = + node.parent && + node.parent.callee && + (node.parent.callee.name === 'tryExecute' || node.parent.callee.name === 'tryExecuteAndNotify'); + if (!hasTryExecuteAndNotify) { + context.report({ + node, + message: 'Wrap this call with `tryExecuteAndNotify()`. Make sure to `await` the result.', + fix: (fixer) => [ + fixer.insertTextBefore(node, 'tryExecuteAndNotify(this, '), + fixer.insertTextAfter(node, ')'), + ], + }); + } + } + }, + }; + }, +}; diff --git a/src/Umbraco.Web.UI.Client/devops/eslint/rules/no-relative-import-to-import-map-module.cjs b/src/Umbraco.Web.UI.Client/devops/eslint/rules/no-relative-import-to-import-map-module.cjs new file mode 100644 index 0000000000..03e99fc901 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/eslint/rules/no-relative-import-to-import-map-module.cjs @@ -0,0 +1,56 @@ +const fs = require('fs'); +const path = require('path'); + +const getDirectories = (source) => + fs + .readdirSync(source, { withFileTypes: true }) + .filter((dirent) => dirent.isDirectory()) + .map((dirent) => dirent.name); + +// TODO: get the correct list of modules. This is a temporary solution where we assume that a directory is equivalent to a module +// TODO: include package modules in this list +const coreRoot = path.join(__dirname, '../../../', 'src/packages/core'); +const externalRoot = path.join(__dirname, '../../../', 'src/external'); +const libsRoot = path.join(__dirname, '../../../', 'src/libs'); +const coreModules = getDirectories(coreRoot).map((dir) => `/core/${dir}/`); +const externalModules = getDirectories(externalRoot).map((dir) => `/${dir}/`); +const libsModules = getDirectories(libsRoot).map((dir) => `/${dir}/`); + +const modulePathIdentifiers = [...coreModules, ...externalModules, ...libsModules]; + +/** @type {import('eslint').Rule.RuleModule} */ +module.exports = { + meta: { + type: 'problem', + docs: { + description: 'Prevent relative import to a module that is in the import map.', + category: 'Best Practices', + recommended: true, + }, + schema: [], + messages: { + unexpectedValue: 'Relative import paths should include "{{value}}".', + }, + }, + create: function (context) { + return { + ImportDeclaration(node) { + // exclude test and story files + if (context.filename.endsWith('.test.ts') || context.filename.endsWith('.stories.ts')) { + return {}; + } + + const importPath = node.source.value; + + if (importPath.startsWith('./') || importPath.startsWith('../')) { + if (modulePathIdentifiers.some((moduleName) => importPath.includes(moduleName))) { + context.report({ + node, + message: 'Use the correct import map alias instead of a relative import path: ' + importPath, + }); + } + } + }, + }; + }, +}; diff --git a/src/Umbraco.Web.UI.Client/devops/eslint/rules/prefer-import-aliases.cjs b/src/Umbraco.Web.UI.Client/devops/eslint/rules/prefer-import-aliases.cjs new file mode 100644 index 0000000000..6794a4426c --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/eslint/rules/prefer-import-aliases.cjs @@ -0,0 +1,26 @@ +/** @type {import('eslint').Rule.RuleModule} */ +module.exports = { + meta: { + type: 'suggestion', + docs: { + description: + 'Ensures that the application does not rely on file system paths for imports. Instead, use import aliases or relative imports. This also solves a problem where GitHub fails on the test runner step.', + category: 'Best Practices', + recommended: true, + }, + schema: [], + }, + create: function (context) { + return { + ImportDeclaration: function (node) { + if (node.source.value.startsWith('src/')) { + context.report({ + node, + message: + 'Prefer using import aliases or relative imports instead of absolute imports. Example: `import { MyComponent } from "src/components/MyComponent";` should be `import { MyComponent } from "@components/MyComponent";`', + }); + } + }, + }; + }, +}; diff --git a/src/Umbraco.Web.UI.Client/devops/eslint/rules/prefer-static-styles-last.cjs b/src/Umbraco.Web.UI.Client/devops/eslint/rules/prefer-static-styles-last.cjs new file mode 100644 index 0000000000..2442e18848 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/eslint/rules/prefer-static-styles-last.cjs @@ -0,0 +1,46 @@ +/** @type {import('eslint').Rule.RuleModule}*/ +module.exports = { + meta: { + type: 'suggestion', + docs: { + description: + 'Enforce the "styles" property with the static modifier to be the last property of a class that ends with "Element".', + category: 'Best Practices', + recommended: true, + }, + fixable: 'code', + schema: [], + }, + create: function (context) { + return { + ClassDeclaration(node) { + const className = node.id.name; + if (className.endsWith('Element')) { + const staticStylesProperty = node.body.body.find((bodyNode) => { + return bodyNode.type === 'PropertyDefinition' && bodyNode.key.name === 'styles' && bodyNode.static; + }); + if (staticStylesProperty) { + const lastProperty = node.body.body[node.body.body.length - 1]; + if (lastProperty.key.name !== staticStylesProperty.key.name) { + context.report({ + node: staticStylesProperty, + message: 'The "styles" property should be the last property of a class declaration.', + data: { + className: className, + }, + fix: function (fixer) { + const sourceCode = context.getSourceCode(); + const staticStylesPropertyText = sourceCode.getText(staticStylesProperty); + return [ + fixer.replaceTextRange(staticStylesProperty.range, ''), + fixer.insertTextAfterRange(lastProperty.range, '\n \n ' + staticStylesPropertyText), + ]; + }, + }); + } + } + } + }, + }; + }, +}; diff --git a/src/Umbraco.Web.UI.Client/devops/eslint/rules/umb-class-prefix.cjs b/src/Umbraco.Web.UI.Client/devops/eslint/rules/umb-class-prefix.cjs new file mode 100644 index 0000000000..b9dce9c039 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/eslint/rules/umb-class-prefix.cjs @@ -0,0 +1,26 @@ +/** @type {import('eslint').Rule.RuleModule} */ +module.exports = { + meta: { + type: 'problem', + docs: { + description: 'Ensure that all class declarations are prefixed with "Umb"', + category: 'Best Practices', + recommended: true, + }, + schema: [], + }, + create: function (context) { + function checkClassName(node) { + if (node.id && node.id.name && !node.id.name.startsWith('Umb')) { + context.report({ + node: node.id, + message: 'Class declaration should be prefixed with "Umb"', + }); + } + } + + return { + ClassDeclaration: checkClassName, + }; + }, +}; diff --git a/src/Umbraco.Web.UI.Client/devops/example-runner/index.js b/src/Umbraco.Web.UI.Client/devops/example-runner/index.js new file mode 100644 index 0000000000..2dd960c198 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/example-runner/index.js @@ -0,0 +1,49 @@ +import * as readline from 'readline'; +import { execSync } from 'child_process'; +import { readdir } from 'fs/promises'; + +const exampleDirectory = 'examples'; + +const getDirectories = async (source) => + (await readdir(source, { withFileTypes: true })) + .filter(dirent => dirent.isDirectory()) + .map(dirent => dirent.name) + +async function pickExampleUI(){ + + // Find sub folder: + const exampleFolderNames = await getDirectories(`${exampleDirectory}`); + + // Create UI: + const rl = readline.createInterface({ + input: process.stdin, + output: process.stdout + }); + + // List examples: + console.log('Please select an example by entering the corresponding number:'); + exampleFolderNames.forEach((folder, index) => { + console.log(`[${index + 1}] ${folder}`); + }); + + // Ask user to select an example: + rl.question('Enter your selection: ', (answer) => { + + // User picked an example: + const selectedFolder = exampleFolderNames[parseInt(answer) - 1]; + console.log(`You selected: ${selectedFolder}`); + + process.env['VITE_EXAMPLE_PATH'] = `${exampleDirectory}/${selectedFolder}`; + + // Start vite server: + try { + execSync('npm run dev', {stdio: 'inherit'}); + } catch (error) { + // Nothing, cause this is most likely just the server begin stopped. + //console.log(error); + } + }); + +}; + +pickExampleUI(); diff --git a/src/Umbraco.Web.UI.Client/devops/icons/index.js b/src/Umbraco.Web.UI.Client/devops/icons/index.js new file mode 100644 index 0000000000..a37ebf36db --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/icons/index.js @@ -0,0 +1,203 @@ +import { readFileSync, writeFile, mkdir, rmSync } from 'fs'; +import * as globModule from 'tiny-glob'; +import * as pathModule from 'path'; + +const path = pathModule.default; +const getDirName = path.dirname; +const glob = globModule.default; + +const moduleDirectory = 'src/packages/core/icon-registry'; +const iconsOutputDirectory = `${moduleDirectory}/icons`; +const umbracoSvgDirectory = `${moduleDirectory}/svgs`; +const iconMapJson = `${moduleDirectory}/icon-dictionary.json`; + +const lucideSvgDirectory = 'node_modules/lucide-static/icons'; +const simpleIconsSvgDirectory = 'node_modules/simple-icons/icons'; + +const run = async () => { + // Empty output directory: + rmSync(iconsOutputDirectory, { recursive: true }); + + var icons = await collectDictionaryIcons(); + icons = await collectDiskIcons(icons); + writeIconsToDisk(icons); + generateJS(icons); +}; + +const collectDictionaryIcons = async () => { + const rawData = readFileSync(iconMapJson); + const fileRaw = rawData.toString(); + const fileJSON = JSON.parse(fileRaw); + + let icons = []; + + // Lucide: + fileJSON.lucide.forEach((iconDef) => { + if (iconDef.file && iconDef.name) { + const path = lucideSvgDirectory + '/' + iconDef.file; + + try { + const rawData = readFileSync(path); + // For Lucide icons specially we adjust the icons a bit for them to work in our case: [NL] + let svg = rawData.toString().replace(' width="24"\n', ''); + svg = svg.replace(' height="24"\n', ''); + svg = svg.replace('stroke-width="2"', 'stroke-width="1.75"'); + const iconFileName = iconDef.name; + + const icon = { + name: iconDef.name, + legacy: iconDef.legacy, + fileName: iconFileName, + svg, + output: `${iconsOutputDirectory}/${iconFileName}.ts`, + }; + + icons.push(icon); + } catch (e) { + console.log(`[Lucide] Could not load file: '${path}'`); + } + } + }); + + // SimpleIcons: + fileJSON.simpleIcons.forEach((iconDef) => { + if (iconDef.file && iconDef.name) { + const path = simpleIconsSvgDirectory + '/' + iconDef.file; + + try { + const rawData = readFileSync(path); + let svg = rawData.toString(); + const iconFileName = iconDef.name; + + // SimpleIcons need to use fill="currentColor" + const pattern = /fill=/g; + if (!pattern.test(svg)) { + svg = svg.replace(/ { + if (iconDef.file && iconDef.name) { + const path = umbracoSvgDirectory + '/' + iconDef.file; + + try { + const rawData = readFileSync(path); + const svg = rawData.toString(); + const iconFileName = iconDef.name; + + const icon = { + name: iconDef.name, + legacy: iconDef.legacy, + fileName: iconFileName, + svg, + output: `${iconsOutputDirectory}/${iconFileName}.ts`, + }; + + icons.push(icon); + } catch (e) { + console.log(`[Umbraco] Could not load file: '${path}'`); + } + } + }); + + return icons; +}; + +const collectDiskIcons = async (icons) => { + const iconPaths = await glob(`${umbracoSvgDirectory}/icon-*.svg`); + + iconPaths.forEach((path) => { + const rawData = readFileSync(path); + const svg = rawData.toString(); + const parsed = pathModule.parse(path); + + if (!parsed) { + console.log('No match found for: ', path); + return; + } + + const SVGFileName = parsed.name; + const iconFileName = SVGFileName.replace('.svg', ''); + const iconName = iconFileName; + + // Only append not already defined icons: + if (!icons.find((x) => x.name === iconName)) { + const icon = { + name: iconName, + legacy: true, + fileName: iconFileName, + svg, + output: `${iconsOutputDirectory}/${iconFileName}.ts`, + }; + + icons.push(icon); + } + }); + + return icons; +}; + +const writeIconsToDisk = (icons) => { + icons.forEach((icon) => { + const content = 'export default `' + icon.svg + '`;'; + + writeFileWithDir(icon.output, content, (err) => { + if (err) { + // eslint-disable-next-line no-undef + console.log(err); + } + + // eslint-disable-next-line no-undef + //console.log(`icon: ${icon.name} generated`); + }); + }); +}; + +const generateJS = (icons) => { + const JSPath = `${moduleDirectory}/icons.ts`; + + const iconDescriptors = icons.map((icon) => { + return `{ + name: "${icon.name}", + ${icon.legacy ? 'legacy: true,' : ''} + path: () => import("./icons/${icon.fileName}.js"), + }`.replace(/\t/g, ''); // Regex removes white space [NL] + }); + + const content = `export default [${iconDescriptors.join(',')}];`; + + writeFileWithDir(JSPath, content, (err) => { + if (err) { + // eslint-disable-next-line no-undef + console.log(err); + } + + // eslint-disable-next-line no-undef + console.log('Icons outputted and Icon Manifests generated!'); + }); +}; + +const writeFileWithDir = (path, contents, cb) => { + mkdir(getDirName(path), { recursive: true }, function (err) { + if (err) return cb(err); + + writeFile(path, contents, cb); + }); +}; + +run(); diff --git a/src/Umbraco.Web.UI.Client/devops/icons/todo_implement_this_data_thesaurus.json b/src/Umbraco.Web.UI.Client/devops/icons/todo_implement_this_data_thesaurus.json new file mode 100644 index 0000000000..2573d281d8 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/icons/todo_implement_this_data_thesaurus.json @@ -0,0 +1,5699 @@ +{ + "$schema": "./thesaurus.schema.json", + "icon-zoom-out": { + "thesaurus": [ + "magnifying glass", + "shrink", + "smaller" + ], + "group": "action zoom", + "related": [ + "icon-zoom-in" + ] + }, + "icon-truck": { + "thesaurus": [ + "lorry", + "vehicle", + "van", + "shipping", + "delivery" + ], + "group": "transport vehicle", + "related": [ + "icon-shipping" + ] + }, + "icon-zoom-in": { + "thesaurus": [ + "magnifying glass", + "grow", + "bigger" + ], + "group": "action zoom", + "related": [ + "icon-zoom-out" + ] + }, + "icon-zip": { + "thesaurus": [ + "zipper" + ], + "group": "file", + "related": [] + }, + "icon-axis-rotation": { + "thesaurus": [ + "refresh", + "recycle", + "sync" + ], + "group": "action rotate", + "related": [ + "icon-sync", + "icon-axis-rotation-2", + "icon-axis-rotation-3", + "icon-refresh" + ] + }, + "icon-yen-bag": { + "thesaurus": [ + "cash", + "swag" + ], + "group": "item money bag", + "related": [] + }, + "icon-axis-rotation-2": { + "thesaurus": [ + "refresh", + "recycle", + "sync" + ], + "group": "action rotate", + "related": [ + "icon-axis-rotation", + "icon-axis-rotation-3", + "icon-sync", + "icon-refresh" + ] + }, + "icon-axis-rotation-3": { + "thesaurus": [ + "refresh", + "recycle" + ], + "group": "action rotate", + "related": [ + "icon-axis-rotation", + "icon-axis-rotation-2", + "icon-refresh" + ] + }, + "icon-wrench": { + "thesaurus": [ + "spanner" + ], + "group": "item tool", + "related": [ + "icon-umb-settings", + "icon-tools" + ] + }, + "icon-wine-glass": { + "thesaurus": [ + "goblets", + "wine", + "glasses", + "crockery", + "drinks", + "dinners", + "restaurants" + ], + "group": "item food drink", + "related": [ + "icon-cocktail", + "icon-beer-glass", + "icon-takeaway-cup", + "icon-coffee" + ] + }, + "icon-wrong": { + "thesaurus": [ + "cross", + "x", + "exit", + "quit", + "close", + "error" + ], + "group": "action boolean", + "related": [ + "icon-delete", + "icon-block", + "icon-delete-key", + "icon-backspace", + "icon-check", + "icon-checkbox", + "icon-checkbox-dotted-active", + "icon-circle-dotted-active", + "icon-application-error" + ] + }, + "icon-windows": { + "thesaurus": [ + "microsoft", + "ms" + ], + "group": "logo", + "related": [ + "icon-os-x" + ] + }, + "icon-window-sizes": { + "thesaurus": [ + "square", + "multiple", + "rectangles", + "three", + "3", + "box" + ], + "group": "action window", + "related": [] + }, + "icon-window-popin": { + "thesaurus": [ + "in", + "arrow", + "box", + "rectangle", + "square" + ], + "group": "action window", + "related": [] + }, + "icon-wifi": { + "thesaurus": [ + "internet", + "broadcast", + "waves" + ], + "group": "item tech", + "related": [] + }, + "icon-width": { + "thesaurus": [ + "arrow", + "size", + "resize", + "length" + ], + "group": "action size", + "related": [] + }, + "icon-weight": { + "thesaurus": [ + "kg", + "tonne", + "mass", + "heavy", + "kilo", + "kilogram" + ], + "group": "item", + "related": [ + "icon-legal" + ] + }, + "icon-war": { + "thesaurus": [ + "tank" + ], + "group": "transport vehicle", + "related": [] + }, + "icon-wand": { + "thesaurus": [ + "magic", + "wizard" + ], + "group": "item", + "related": [] + }, + "icon-wallet": { + "thesaurus": [ + "purse", + "money", + "cash", + "pay", + "payment", + "checkout" + ], + "group": "item money", + "related": [] + }, + "icon-wall-plug": { + "thesaurus": [ + "power", + "electricity", + "cable" + ], + "group": "item tech", + "related": [ + "icon-power-outlet", + "icon-dock-connector" + ] + }, + "icon-voice": { + "thesaurus": [ + "microphone", + "podcast", + "audio", + "record" + ], + "group": "item media", + "related": [] + }, + "icon-video": { + "thesaurus": [ + "media", + "movie", + "film", + "camera", + "record" + ], + "group": "item media", + "related": [] + }, + "icon-vcard": { + "thesaurus": [ + "business cards", + "id cards", + "profiles", + "personas", + "person", + "users" + ], + "group": "file", + "related": [ + "icon-umb-members" + ] + }, + "icon-utilities": { + "thesaurus": [ + "toolbox", + "tools" + ], + "group": "item tool", + "related": [ + "icon-briefcase" + ] + }, + "icon-users": { + "thesaurus": [ + "person", + "people", + "three", + "3", + "men", + "man", + "male" + ], + "group": "user multiple", + "related": [ + "icon-users-alt", + "icon-user-females", + "icon-user-females-alt", + "icon-user", + "icon-user-female", + "icon-umb-users" + ] + }, + "icon-users-alt": { + "thesaurus": [ + "person", + "people", + "three", + "3", + "men", + "man", + "male" + ], + "group": "user multiple", + "related": [ + "icon-users-alt", + "icon-user-females", + "icon-user-females-alt", + "icon-user", + "icon-user-female", + "icon-umb-users" + ] + }, + "icon-user": { + "thesaurus": [ + "person", + "people", + "man", + "men", + "male" + ], + "group": "user", + "related": [ + "icon-user-female", + "icon-people", + "icon-people-alt", + "icon-people-alt-2", + "icon-users", + "icon-users-alt", + "icon-user-female", + "icon-umb-users", + "icon-user-glasses", + "icon-client", + "icon-employee", + "icon-piracy", + "icon-theif", + "icon-operator" + ] + }, + "icon-user-glasses": { + "thesaurus": [ + "person", + "people", + "man", + "men", + "male", + "specs", + "nerd" + ], + "group": "user special", + "related": [ + "icon-user", + "icon-user-female", + "icon-umb-users", + "icon-client", + "icon-employee", + "icon-piracy", + "icon-theif", + "icon-operator" + ] + }, + "icon-user-females": { + "thesaurus": [ + "person", + "people", + "three", + "3", + "women", + "woman" + ], + "group": "user multiple", + "related": [ + "icon-users-alt", + "icon-user-females", + "icon-user-females-alt", + "icon-user", + "icon-user-female", + "icon-umb-users" + ] + }, + "icon-user-females-alt": { + "thesaurus": [ + "person", + "people", + "three", + "3", + "women", + "woman" + ], + "group": "user multiple", + "related": [ + "icon-users-alt", + "icon-user-females", + "icon-user-females-alt", + "icon-user", + "icon-user-female", + "icon-umb-users" + ] + }, + "icon-user-female": { + "thesaurus": [ + "person", + "people", + "woman", + "women" + ], + "group": "user", + "related": [ + "icon-people-female", + "icon-user-females", + "icon-user-females-alt", + "icon-user", + "icon-user-female", + "icon-umb-users", + "icon-user-glasses", + "icon-client", + "icon-employee", + "icon-piracy", + "icon-theif", + "icon-operator" + ] + }, + "icon-usb": { + "thesaurus": [], + "group": "item tech", + "related": [ + "icon-usb-connector" + ] + }, + "icon-usb-connector": { + "thesaurus": [ + "plugs", + "peripherals", + "technology" + ], + "group": "item tech", + "related": [ + "icon-usb", + "icon-wall-plug", + "icon-dock-connector" + ] + }, + "icon-unlocked": { + "thesaurus": [ + "padlock", + "insecure" + ], + "group": "item security lock", + "related": [ + "icon-lock", + "icon-combination-lock-open", + "icon-keyhole", + "icon-old-key", + "icon-keychain", + "icon-key" + ] + }, + "icon-universal": { + "thesaurus": [ + "yin yang", + "circle", + "wave" + ], + "group": "misc", + "related": [] + }, + "icon-undo": { + "thesaurus": [ + "arrow", + "back" + ], + "group": "action arrow", + "related": [ + "icon-redo", + "icon-backspace", + "icon-arrow-left", + "icon-navigation-left", + "icon-left-double-arrow" + ] + }, + "icon-umbrella": { + "thesaurus": [ + "rain", + "shelter" + ], + "group": "item household", + "related": [] + }, + "icon-umb-deploy": { + "thesaurus": [ + "circle", + "arrow", + "upload", + "save" + ], + "group": "action arrow circle", + "related": [ + "icon-save" + ] + }, + "icon-umb-contour": { + "thesaurus": [ + "forms", + "add", + "plus", + "boxes", + "fields", + "inputs", + "multiple", + "two", + "2", + "more" + ], + "group": "shape box", + "related": [] + }, + "icon-umb-settings": { + "thesaurus": [ + "spanner", + "wrench" + ], + "group": "item tool", + "related": [ + "icon-wrench", + "icon-tools" + ] + }, + "icon-umb-users": { + "thesaurus": [ + "person", + "people" + ], + "group": "user", + "related": [ + "icon-user", + "icon-user-female", + "icon-user-glasses", + "icon-client", + "icon-employee", + "icon-piracy", + "icon-theif", + "icon-operator" + ] + }, + "icon-umb-media": { + "thesaurus": [ + "photograph", + "image", + "picture", + "mountains", + "scenery", + "landscape" + ], + "group": "picture", + "related": [ + "icon-picture", + "icon-pictures", + "icon-pictures-alt", + "icon-pictures-alt-2", + "icon-photo-album", + "icon-mountain" + ] + }, + "icon-umb-content": { + "thesaurus": [ + "pages", + "papers", + "documents" + ], + "group": "document", + "related": [ + "icon-document", + "icon-document-dashed-line", + "icon-documents", + "icon-article", + "icon-diploma-alt", + "icon-script", + "icon-script-alt" + ] + }, + "icon-umb-developer": { + "thesaurus": [ + "settings", + "cog", + "wheel", + "preferences" + ], + "group": "settings", + "related": [ + "icon-settings", + "icon-settings-alt", + "icon-settings-alt-2" + ] + }, + "icon-umb-members": { + "thesaurus": [ + "business cards", + "id cards", + "profiles", + "personas", + "person", + "users" + ], + "group": "user", + "related": [ + "icon-vcard" + ] + }, + "icon-umb-translation": { + "thesaurus": [ + "globe", + "i18n", + "internationalisation", + "internationalization", + "world", + "internet" + ], + "group": "item globe", + "related": [ + "icon-globe-alt", + "icon-globe", + "icon-globe-inverted-europe-africa", + "icon-globe-inverted-asia", + "icon-globe-inverted-america", + "icon-globe-europe---africa", + "icon-globe-asia" + ] + }, + "icon-tv": { + "thesaurus": [ + "telly", + "tv", + "monitor", + "display" + ], + "group": "item tech", + "related": [ + "icon-tv-old" + ] + }, + "icon-tv-old": { + "thesaurus": [ + "telly", + "tv", + "retro", + "crt" + ], + "group": "item tech", + "related": [ + "icon-tv" + ] + }, + "icon-trophy": { + "thesaurus": [ + "awards", + "cups", + "winnings", + "rewards" + ], + "group": "item award", + "related": [ + "icon-medal", + "icon-diploma", + "icon-diploma-alt" + ] + }, + "icon-tree": { + "thesaurus": [ + "plants", + "woods", + "forests", + "nature", + "outdoors" + ], + "group": "item nature", + "related": [] + }, + "icon-trash": { + "thesaurus": [ + "bin", + "rubbish" + ], + "group": "item household", + "related": [ + "icon-trash-alt", + "icon-trash-alt-2" + ] + }, + "icon-trash-alt": { + "thesaurus": [ + "bin", + "rubbish" + ], + "group": "item household", + "related": [ + "icon-trash", + "icon-trash-alt-2" + ] + }, + "icon-trash-alt-2": { + "thesaurus": [ + "bin", + "rubbish" + ], + "group": "item household", + "related": [ + "icon-trash", + "icon-trash-alt" + ] + }, + "icon-train": { + "thesaurus": [ + "trams", + "railways", + "trains", + "public transport" + ], + "group": "transport vehicle", + "related": [] + }, + "icon-trafic": { + "thesaurus": [ + "arrows", + "bi-directional", + "two", + "2", + "swap" + ], + "group": "action arrow", + "related": [ + "icon-traffic-alt", + "icon-shuffle", + "icon-repeat", + "icon-navigation-road" + ] + }, + "icon-traffic-alt": { + "thesaurus": [ + "arrows", + "bi-directional", + "two", + "2", + "swap", + "navigation" + ], + "group": "action arrow", + "related": [ + "icon-traffic", + "icon-tab-key", + "icon-shuffle", + "icon-repeat", + "icon-repeat-one", + "icon-navigation-road" + ] + }, + "icon-top": { + "thesaurus": [ + "vest" + ], + "group": "item clothing", + "related": [ + "icon-t-shirt" + ] + }, + "icon-tools": { + "thesaurus": [ + "spanner", + "settings", + "wrench", + "screwdriver" + ], + "group": "item tool", + "related": [ + "icon-wrench", + "icon-tools" + ] + }, + "icon-timer": { + "thesaurus": [ + "clock", + "stopwatch" + ], + "group": "item clock", + "related": [] + }, + "icon-time": { + "thesaurus": [ + "clock", + "stopwatch" + ], + "group": "item clock", + "related": [] + }, + "icon-t-shirt": { + "thesaurus": [ + "tshirt", + "top" + ], + "group": "item clothing", + "related": [ + "icon-top" + ] + }, + "icon-tab-key": { + "thesaurus": [ + "arrow", + "line", + "end", + "stop" + ], + "group": "action key arrow", + "related": [ + "icon-traffic-alt", + "icon-traffic", + "icon-shuffle", + "icon-repeat", + "icon-navigation-road" + ] + }, + "icon-tab": { + "thesaurus": [ + "tabs", + "matryoshka" + ], + "group": "action window tab", + "related": [] + }, + "icon-tactics": { + "thesaurus": [ + "tic tac toe", + "arrows", + "naughts and crosses" + ], + "group": "misc", + "related": [] + }, + "icon-tag": { + "thesaurus": [ + "prices", + "labels", + "tags" + ], + "group": "item", + "related": [ + "icon-tags" + ] + }, + "icon-tags": { + "thesaurus": [ + "two", + "2", + "prices", + "labels", + "tags" + ], + "group": "item", + "related": [ + "icon-tag" + ] + }, + "icon-takeaway-cup": { + "thesaurus": [ + "coffee", + "mug", + "tea" + ], + "group": "item food drink", + "related": [ + "icon-coffee", + "icon-cocktail", + "icon-beer-glass", + "icon-wine-glass" + ] + }, + "icon-target": { + "thesaurus": [ + "circles", + "two", + "2", + "nested", + "nesting", + "bullet point", + "radio buttons", + "radios" + ], + "group": "misc", + "related": [] + }, + "icon-temperatrure-alt": { + "thesaurus": [ + "temperature", + "thermometer", + "guage", + "speed", + "scale", + "fuel" + ], + "group": "measure", + "related": [ + "icon-speed-gauge", + "icon-temperature" + ] + }, + "icon-temperature": { + "thesaurus": [ + "thermometer", + "health" + ], + "group": "measure", + "related": [ + "icon-temperatrure-alt" + ] + }, + "icon-terminal": { + "thesaurus": [ + "console", + "commands", + "line", + "code", + "developers", + "cli" + ], + "group": "action window", + "related": [] + }, + "icon-theater": { + "thesaurus": [ + "theatre", + "masks", + "arts", + "theatrical", + "costume" + ], + "group": "building", + "related": [] + }, + "icon-theif": { + "thesaurus": [ + "burglar", + "criminal", + "secret agent", + "spy", + "bandit" + ], + "group": "user special", + "related": [ + "icon-user", + "icon-user-female", + "icon-umb-users", + "icon-user-glasses", + "icon-client", + "icon-employee", + "icon-piracy", + "icon-operator" + ] + }, + "icon-thought-bubble": { + "thesaurus": [ + "thinking", + "speech bubble", + "thought", + "idea" + ], + "group": "misc", + "related": [] + }, + "icon-thumb-down": { + "thesaurus": [ + "no", + "thumbs down" + ], + "group": "item hand thumb", + "related": [ + "icon-thumb-up" + ] + }, + "icon-thumb-up": { + "thesaurus": [ + "yes", + "thumbs up" + ], + "group": "item hand thumb", + "related": [ + "icon-thumb-down" + ] + }, + "icon-thumbnail-list": { + "thesaurus": [ + "media" + ], + "group": "shape box layout", + "related": [] + }, + "icon-thumbnails-small": { + "thesaurus": [ + "grid", + "boxes", + "squares", + "nine", + "9" + ], + "group": "shape box layout", + "related": [ + "icon-thumbnails", + "icon-grid", + "icon-stop", + "icon-thumbnail-list", + "icon-item-arrangement" + ] + }, + "icon-thumbnails": { + "thesaurus": [ + "grid", + "boxes", + "squares", + "four", + "4" + ], + "group": "shape box layout", + "related": [ + "icon-thumbnails-small", + "icon-grid", + "icon-stop", + "icon-thumbnail-list" + ] + }, + "icon-ticket": { + "thesaurus": [ + "one", + "1" + ], + "group": "item money note ticket", + "related": [ + "icon-coins", + "icon-bills" + ] + }, + "icon-sync": { + "thesaurus": [ + "refresh", + "recycle", + "sync" + ], + "group": "action rotate", + "related": [ + "icon-axis-rotation", + "icon-axis-rotation-2", + "icon-axis-rotation-3", + "icon-refresh", + "icon-re-post" + ] + }, + "icon-sweatshirt": { + "thesaurus": [ + "jumper", + "pullover" + ], + "group": "item clothing", + "related": [ + "icon-top", + "icon-t-shirt" + ] + }, + "icon-sunny": { + "thesaurus": [ + "weather", + "summer" + ], + "group": "weather", + "related": [ + "icon-snow", + "icon-cloudy", + "icon-cloud" + ] + }, + "icon-stream": { + "thesaurus": [ + "circle", + "wave", + "sine", + "alternating current" + ], + "group": "misc", + "related": [] + }, + "icon-store": { + "thesaurus": [ + "shop", + "market", + "supermarket", + "superstore" + ], + "group": "building", + "related": [] + }, + "icon-stop": { + "thesaurus": [ + "square" + ], + "group": "shape box", + "related": [ + "icon-thumbnails", + "icon-thumbnails-small", + "icon-record", + "icon-play", + "icon-pause" + ] + }, + "icon-stop-hand": { + "thesaurus": [ + "palm" + ], + "group": "item hand", + "related": [ + "icon-stop-alt", + "icon-stop-hand" + ] + }, + "icon-stop-alt": { + "thesaurus": [ + "sign", + "octagon", + "eight", + "8" + ], + "group": "misc", + "related": [ + "icon-stop", + "icon-stop-hand" + ] + }, + "icon-stamp": { + "thesaurus": [ + "frame", + "photos", + "photographs", + "pictures", + "images", + "icon-shipping-box" + ], + "group": "item", + "related": [] + }, + "icon-stacked-disks": { + "thesaurus": [ + "hard drives", + "ssd", + "hdd", + "servers", + "rack", + "hardware" + ], + "group": "item tech hardware", + "related": [ + "icon-server", + "icon-disk-image", + "icon-ssd" + ] + }, + "icon-ssd": { + "thesaurus": [ + "disk", + "hdd", + "sata", + "hardware" + ], + "group": "item tech hardware", + "related": [ + "icon-server", + "icon-disk-image", + "icon-ssd" + ] + }, + "icon-squiggly-line": { + "thesaurus": [ + "wave", + "random", + "squiggle" + ], + "group": "misc", + "related": [ + "icon-stream" + ] + }, + "icon-sprout": { + "thesaurus": [ + "plant", + "sapling", + "spring" + ], + "group": "item nature", + "related": [ + "icon-tree" + ] + }, + "icon-split": { + "thesaurus": [ + "arrows", + "fork", + "two", + "2" + ], + "group": "action arrow", + "related": [ + "icon-split-alt" + ] + }, + "icon-split-alt": { + "thesaurus": [ + "arrows", + "fork", + "three", + "3" + ], + "group": "action arrow", + "related": [ + "icon-split" + ] + }, + "icon-speed-gauge": { + "thesaurus": [ + "guage", + "speed", + "scale", + "fuel" + ], + "group": "measure", + "related": [ + "icon-temperatrure-alt" + ] + }, + "icon-speaker": { + "thesaurus": [ + "sounds", + "audio", + "music", + "speakers", + "amplifiers", + "amps" + ], + "group": "item media", + "related": [ + "icon-sound", + "icon-sound-waves" + ] + }, + "icon-sound": { + "thesaurus": [ + "sounds", + "audio", + "music", + "speakers", + "amplifiers", + "amps", + "volume", + "maximum" + ], + "group": "item media", + "related": [ + "icon-sound-medium", + "icon-sound-low", + "icon-sound-off", + "icon-sound-waves", + "icon-speaker" + ] + }, + "icon-spades": { + "thesaurus": [], + "group": "misc game", + "related": [] + }, + "icon-sound-waves": { + "thesaurus": [ + "sounds", + "audio", + "music" + ], + "group": "item media", + "related": [] + }, + "icon-shipping-box": { + "thesaurus": [ + "grid", + "grill", + "lines" + ], + "group": "shape box", + "related": [] + }, + "icon-shipping": { + "thesaurus": [ + "trailer", + "sack truck", + "boxes", + "lift", + "carry" + ], + "group": "commerce", + "related": [ + "icon-truck" + ] + }, + "icon-shoe": { + "thesaurus": [ + "trainers", + "sneakers" + ], + "group": "item clothing", + "related": [] + }, + "icon-shopping-basket-alt-2": { + "thesaurus": [ + "carts", + "checkouts" + ], + "group": "commerce", + "related": [ + "icon-shopping-basket", + "item-shopping-basket-alt" + ] + }, + "icon-shopping-basket": { + "thesaurus": [ + "trolley", + "trollies", + "supermarket" + ], + "group": "commerce", + "related": [ + "icon-shopping-basket-alt", + "item-shopping-basket-alt-2" + ] + }, + "icon-shopping-basket-alt": { + "thesaurus": [ + "bag", + "gift" + ], + "group": "commerce", + "related": [ + "icon-shopping-basket", + "item-shopping-basket-alt-2" + ] + }, + "icon-shorts": { + "thesaurus": [ + "trousers", + "bottoms", + "pants" + ], + "group": "item clothing", + "related": [] + }, + "icon-shuffle": { + "thesaurus": [ + "arrows", + "two", + "2", + "mix", + "random" + ], + "group": "action arrow", + "related": [ + "icon-traffic-alt", + "icon-tab-key", + "icon-traffic", + "icon-repeat", + "icon-navigation-road" + ] + }, + "icon-sience": { + "thesaurus": [ + "nuclear", + "orbit" + ], + "group": "misc", + "related": [] + }, + "icon-simcard": { + "thesaurus": [ + "technology", + "telephony", + "phones", + "mobiles", + "cellphones" + ], + "group": "item tech hardware", + "related": [] + }, + "icon-single-note": { + "thesaurus": [ + "music", + "sounds", + "audio" + ], + "group": "item media", + "related": [] + }, + "icon-sitemap": { + "thesaurus": [ + "trees", + "family trees", + "hierachies", + "hierachy", + "structure", + "flowcharts", + "flow charts", + "flow diagrams" + ], + "group": "data", + "related": [] + }, + "icon-sleep": { + "thesaurus": [ + "moons", + "crescent", + "nighttime" + ], + "group": "weather", + "related": [] + }, + "icon-slideshow": { + "thesaurus": [ + "powerpoints", + "data", + "keynotes", + "presentations", + "slideshows", + "slide shows" + ], + "group": "item workplace", + "related": [] + }, + "icon-smiley-inverted": { + "thesaurus": [ + "emojis", + "emoticons", + "faces", + "people", + "person", + "user", + "happy", + "happiness" + ], + "group": "user", + "related": [ + "icon-smiley" + ] + }, + "icon-smiley": { + "thesaurus": [ + "emojis", + "emoticons", + "faces", + "people", + "person", + "user", + "happy", + "happiness" + ], + "group": "user", + "related": [ + "icon-smiley-inverted" + ] + }, + "icon-snow": { + "thesaurus": [ + "snowing", + "cold", + "winter", + "hailing" + ], + "group": "weather cloud", + "related": [] + }, + "icon-sound-low": { + "thesaurus": [ + "sounds", + "audio", + "music", + "speakers", + "amplifiers", + "amps", + "volume", + "minimum" + ], + "group": "item media", + "related": [ + "icon-sound-medium", + "icon-sound", + "icon-sound-off", + "icon-sound-waves", + "icon-speaker" + ] + }, + "icon-sound-medium": { + "thesaurus": [ + "sounds", + "audio", + "music", + "speakers", + "amplifiers", + "amps", + "volume", + "medium" + ], + "group": "item media", + "related": [ + "icon-sound", + "icon-sound-low", + "icon-sound-off", + "icon-sound-waves", + "icon-speaker" + ] + }, + "icon-sound-off": { + "thesaurus": [ + "sounds", + "audio", + "music", + "speakers", + "amplifiers", + "amps", + "volume", + "muted" + ], + "group": "item media", + "related": [ + "icon-sound-medium", + "icon-sound-low", + "icon-sound", + "icon-sound-waves", + "icon-speaker" + ] + }, + "icon-shift": { + "thesaurus": [ + "arrows", + "up" + ], + "group": "action key", + "related": [] + }, + "icon-shield": { + "thesaurus": [ + "security", + "protect", + "secure", + "badge" + ], + "group": "item security", + "related": [] + }, + "icon-sharing-iphone": { + "thesaurus": [ + "share", + "export", + "arrows", + "boxes" + ], + "group": "action arrow box", + "related": [] + }, + "icon-share": { + "thesaurus": [ + "networks", + "social media" + ], + "group": "action", + "related": [] + }, + "icon-share-alt": { + "thesaurus": [ + "broadcasts", + "waves" + ], + "group": "action", + "related": [] + }, + "icon-share-alt-2": { + "thesaurus": [ + "eyes", + "hands", + "sharing", + "holding" + ], + "group": "action", + "related": [] + }, + "icon-settings": { + "thesaurus": [ + "settings", + "cog", + "wheel", + "preferences" + ], + "group": "settings", + "related": [ + "icon-umb-developer", + "icon-settings-alt", + "icon-settings-alt-2" + ] + }, + "icon-settings-alt": { + "thesaurus": [ + "settings", + "cog", + "wheel", + "preferences" + ], + "group": "settings", + "related": [ + "icon-settings", + "icon-umb-developer", + "icon-settings-alt-2" + ] + }, + "icon-settings-alt-2": { + "thesaurus": [ + "settings", + "cog", + "wheel", + "preferences" + ], + "group": "settings", + "related": [ + "icon-settings", + "icon-settings-alt", + "icon-umb-developer" + ] + }, + "icon-server": { + "thesaurus": [ + "servers", + "rack", + "hardware" + ], + "group": "item tech hardware", + "related": [ + "icon-stacked-disks", + "icon-disk-image", + "icon-ssd" + ] + }, + "icon-server-alt": { + "thesaurus": [ + "db", + "databases", + "data store" + ], + "group": "item tech hardware", + "related": [] + }, + "icon-sensor": { + "thesaurus": [ + "waves", + "earthquake", + "epicentre", + "epicenter" + ], + "group": "misc", + "related": [] + }, + "icon-security-camera": { + "thesaurus": [ + "webcams", + "cctv" + ], + "group": "item tech", + "related": [] + }, + "icon-search": { + "thesaurus": [ + "magnifying glass" + ], + "group": "item household", + "related": [] + }, + "icon-scull": { + "thesaurus": [ + "dead", + "death", + "expired", + "old", + "skull", + "pirate", + "piracy" + ], + "group": "item", + "related": [ + "icon-piracy" + ] + }, + "icon-script": { + "thesaurus": [ + "scroll", + "javascript", + "js" + ], + "group": "file", + "related": [ + "icon-script-alt" + ] + }, + "icon-script-alt": { + "thesaurus": [ + "scroll", + "javascript", + "js" + ], + "group": "file", + "related": [ + "icon-script" + ] + }, + "icon-screensharing": { + "thesaurus": [ + "boxes", + "multiple", + "two", + "2", + "nested", + "restore" + ], + "group": "shape box", + "related": [ + "icon-layers-alt" + ] + }, + "icon-school": { + "thesaurus": [ + "clock tower", + "town hall", + "building", + "university" + ], + "group": "building", + "related": [] + }, + "icon-scan": { + "thesaurus": [ + "radar" + ], + "group": "misc", + "related": [] + }, + "icon-refresh": { + "thesaurus": [ + "arrow", + "recycle", + "sync", + "repeat" + ], + "group": "action rotate", + "related": [ + "icon-axis-rotation", + "icon-axis-rotation-2", + "icon-axis-rotation-3", + "icon-sync", + "icon-re-post" + ] + }, + "icon-remote": { + "thesaurus": [ + "remote controls", + "buttons" + ], + "group": "item household", + "related": [] + }, + "icon-remove": { + "thesaurus": [ + "minus", + "subtracts", + "lines", + "deletes" + ], + "group": "maths", + "related": [] + }, + "icon-repeat-one": { + "thesaurus": [ + "arrows", + "bi-directional", + "two", + "2", + "swap", + "loop", + "reverse" + ], + "group": "action arrow", + "related": [ + "icon-repeat", + "icon-traffic-alt", + "icon-tab-key", + "icon-shuffle", + "icon-traffic", + "icon-navigation-road" + ] + }, + "icon-repeat": { + "thesaurus": [ + "arrows", + "bi-directional", + "two", + "2", + "swap", + "loop", + "reverse" + ], + "group": "action arrow", + "related": [ + "icon-repeat-one", + "icon-traffic-alt", + "icon-tab-key", + "icon-shuffle", + "icon-traffic", + "icon-navigation-road" + ] + }, + "icon-resize": { + "thesaurus": [ + "arrows", + "move", + "resizes", + "scales" + ], + "group": "action arrow", + "related": [] + }, + "icon-reply-arrow": { + "thesaurus": [ + "arrows", + "back" + ], + "group": "action arrow", + "related": [] + }, + "icon-return-to-top": { + "thesaurus": [ + "loops", + "repeats", + "arrows" + ], + "group": "action arrow", + "related": [] + }, + "icon-right-double-arrow": { + "thesaurus": [ + "chevrons", + "two", + "2" + ], + "group": "action arrow", + "related": [] + }, + "icon-road": { + "thesaurus": [ + "streets", + "highways", + "lanes", + "motorways", + "roads" + ], + "group": "transport", + "related": [] + }, + "icon-roadsign": { + "thesaurus": [ + "warnings" + ], + "group": "transport", + "related": [] + }, + "icon-rocket": { + "thesaurus": [ + "space", + "launches" + ], + "group": "transport vehicle", + "related": [] + }, + "icon-rss": { + "thesaurus": [ + "rss feed", + "syndication", + "broadcasts", + "waves" + ], + "group": "item tech", + "related": [] + }, + "icon-ruler-alt": { + "thesaurus": [ + "triangles", + "set squares", + "measures", + "tools" + ], + "group": "item tool", + "related": [] + }, + "icon-ruler": { + "thesaurus": [ + "measures", + "tools" + ], + "group": "item tool", + "related": [] + }, + "icon-sandbox-toys": { + "thesaurus": [ + "bucket", + "spade" + ], + "group": "item tool", + "related": [] + }, + "icon-satellite-dish": { + "thesaurus": [ + "broadcasts", + "transmits", + "receiver" + ], + "group": "item tech hardware", + "related": [] + }, + "icon-save": { + "thesaurus": [ + "imports", + "circles", + "arrows" + ], + "group": "action arrow circle", + "related": [ + "icon-umb-deploy" + ] + }, + "icon-safedial": { + "thesaurus": [ + "codes", + "secrets", + "locked" + ], + "group": "item security lock", + "related": [] + }, + "icon-safe": { + "thesaurus": [ + "codes", + "secrets", + "locked", + "dial" + ], + "group": "item security lock", + "related": [] + }, + "icon-redo": { + "thesaurus": [ + "arrow", + "forward" + ], + "group": "action arrow", + "related": [ + "icon-undo", + "icon-delete-key", + "icon-arrow-right", + "icon-navigation-right", + "icon-right-double-arrow" + ] + }, + "icon-printer-alt": { + "thesaurus": [ + "printers", + "peripherals" + ], + "group": "item tech hardware", + "related": [ + "icon-print" + ] + }, + "icon-planet": { + "thesaurus": [ + "space", + "saturn" + ], + "group": "item globe", + "related": [] + }, + "icon-paste-in": { + "thesaurus": [ + "clipboard" + ], + "group": "action", + "related": [] + }, + "icon-os-x": { + "thesaurus": [ + "mac", + "apple" + ], + "group": "logo", + "related": [ + "icon-windows" + ] + }, + "icon-navigation-left": { + "thesaurus": [ + "arrows", + "triangles" + ], + "group": "action arrow", + "related": [] + }, + "icon-message": { + "thesaurus": [ + "emails", + "envelopes", + "letters", + "sms" + ], + "group": "item household", + "related": [ + "icon-message-unopened", + "icon-message-open" + ] + }, + "icon-lock": { + "thesaurus": [ + "padlocks", + "locks", + "security", + "secret", + "locked" + ], + "group": "item security", + "related": [ + "icon-lock", + "icon-combination-lock", + "icon-keyhole", + "icon-old-key", + "icon-keychain", + "icon-key" + ] + }, + "icon-layers-alt": { + "thesaurus": [ + "boxes", + "multiple", + "three", + "3", + "nested", + "restore" + ], + "group": "shape box", + "related": [ + "icon-screensharing" + ] + }, + "icon-record": { + "thesaurus": [ + "circles" + ], + "group": "shape", + "related": [] + }, + "icon-print": { + "thesaurus": [ + "printer", + "print" + ], + "group": "item tech hardware", + "related": [ + "icon-printer-alt" + ] + }, + "icon-plane": { + "thesaurus": [ + "airplanes", + "aeroplanes", + "aircraft", + "flying", + "flight" + ], + "group": "transport vehicle", + "related": [] + }, + "icon-partly-cloudy": { + "thesaurus": [ + "sunny spells" + ], + "group": "weather cloud", + "related": [] + }, + "icon-ordered-list": { + "thesaurus": [ + "numbered list", + "numbers" + ], + "group": "action format", + "related": [] + }, + "icon-navigation-last": { + "thesaurus": [ + "end", + "finish" + ], + "group": "action arrow", + "related": [] + }, + "icon-message-unopened": { + "thesaurus": [ + "emails", + "envelopes", + "letters", + "sms" + ], + "group": "item household", + "related": [ + "icon-message", + "icon-message-open" + ] + }, + "icon-location-nearby": { + "thesaurus": [ + "geolocation", + "maps", + "pins" + ], + "group": "misc", + "related": [ + "icon-pin-location", + "icon-location-near-me" + ] + }, + "icon-laptop": { + "thesaurus": [ + "pc", + "computers", + "macbooks" + ], + "group": "item tech hardware", + "related": [] + }, + "icon-reception": { + "thesaurus": [ + "receptionists", + "desks", + "working" + ], + "group": "user", + "related": [] + }, + "icon-price-yen": { + "thesaurus": [ + "buy", + "money" + ], + "group": "item money", + "related": [] + }, + "icon-piracy": { + "thesaurus": [ + "pirates", + "person", + "people", + "users" + ], + "group": "user special", + "related": [ + "icon-user", + "icon-user-female", + "icon-umb-users", + "icon-user-glasses", + "icon-client", + "icon-employee", + "icon-piracy", + "icon-theif", + "icon-operator", + "icon-scull" + ] + }, + "icon-parental-control": { + "thesaurus": [ + "children", + "parents", + "family", + "families", + "mom", + "mum", + "mummy", + "mommy", + "mother", + "father", + "dad", + "son", + "daughter" + ], + "group": "user", + "related": [] + }, + "icon-operator": { + "thesaurus": [ + "microphones", + "users", + "people", + "person", + "support", + "phonecalls", + "call centres", + "call centers" + ], + "group": "user special", + "related": [ + "icon-user", + "icon-user-female", + "icon-umb-users", + "icon-user-glasses", + "icon-client", + "icon-employee", + "icon-piracy", + "icon-theif", + "icon-operator" + ] + }, + "icon-navigation-horizontal": { + "thesaurus": [ + "arrows", + "lengths", + "widths", + "measure" + ], + "group": "action arrow", + "related": [] + }, + "icon-message-open": { + "thesaurus": [ + "emails", + "envelopes", + "letters", + "sms" + ], + "group": "item household", + "related": [ + "icon-message-unopened", + "icon-message" + ] + }, + "icon-lab": { + "thesaurus": [ + "science", + "beaker", + "test tube", + "testtube" + ], + "group": "misc", + "related": [] + }, + "icon-location-near-me": { + "thesaurus": [ + "geolocation", + "maps", + "pins" + ], + "group": "misc", + "related": [ + "icon-pin-location", + "icon-location-nearby" + ] + }, + "icon-receipt-yen": { + "thesaurus": [ + "invoice" + ], + "group": "item money receipt", + "related": [ + "icon-receipt-pound", + "icon-receipt-euro", + "icon-receipt-dollar", + "icon-receipt-alt" + ] + }, + "icon-price-pound": { + "thesaurus": [], + "group": "item money", + "related": [] + }, + "icon-pin-location": { + "thesaurus": [ + "geolocation", + "maps", + "pins" + ], + "group": "misc", + "related": [ + "icon-location-nearby", + "icon-location-near-me" + ] + }, + "icon-parachute-drop": { + "thesaurus": [], + "group": "sport", + "related": [] + }, + "icon-old-phone": { + "thesaurus": [ + "telephones" + ], + "group": "item household phone", + "related": [ + "icon-iphone", + "icon-phone", + "icon-phone-ring" + ] + }, + "icon-merge": { + "thesaurus": [], + "group": "action arrow", + "related": [] + }, + "icon-navigation-first": { + "thesaurus": [ + "start", + "beginning" + ], + "group": "action arrow", + "related": [] + }, + "icon-locate": { + "thesaurus": [ + "crosshairs", + "gps", + "location" + ], + "group": "space", + "related": [] + }, + "icon-keyhole": { + "thesaurus": [], + "group": "item security", + "related": [ + "icon-lock", + "icon-keyhole", + "icon-old-key", + "icon-keychain", + "icon-key" + ] + }, + "icon-receipt-pound": { + "thesaurus": [], + "group": "item money receipt", + "related": [ + "icon-receipt-yen", + "icon-receipt-euro", + "icon-receipt-dollar", + "icon-receipt-alt" + ] + }, + "icon-price-euro": { + "thesaurus": [], + "group": "item money", + "related": [] + }, + "icon-piggy-bank": { + "thesaurus": [ + "animals", + "farms", + "pigs" + ], + "group": "item money", + "related": [] + }, + "icon-paper-plane": { + "thesaurus": [ + "paper aeroplane", + "paper airplane", + "sending", + "sends", + "sent", + "delivers" + ], + "group": "item household", + "related": [ + "icon-paper-plane-alt" + ] + }, + "icon-old-key": { + "thesaurus": [], + "group": "item security", + "related": [ + "icon-lock", + "icon-keyhole", + "icon-old-key", + "icon-keychain", + "icon-key" + ] + }, + "icon-navigation-down": { + "thesaurus": [ + "arrows", + "triangles" + ], + "group": "action arrow", + "related": [] + }, + "icon-megaphone": { + "thesaurus": [ + "announcements" + ], + "group": "item household", + "related": [] + }, + "icon-loading": { + "thesaurus": [ + "watches", + "clocks", + "time" + ], + "group": "item clock", + "related": [] + }, + "icon-keychain": { + "thesaurus": [], + "group": "item security", + "related": [ + "icon-lock", + "icon-keyhole", + "icon-old-key", + "icon-keychain", + "icon-key" + ] + }, + "icon-receipt-euro": { + "thesaurus": [], + "group": "item money receipt", + "related": [ + "icon-receipt-yen", + "icon-receipt-pound", + "icon-receipt-dollar", + "icon-receipt-alt" + ] + }, + "icon-price-dollar": { + "thesaurus": [], + "group": "item money", + "related": [] + }, + "icon-pie-chart": { + "thesaurus": [ + "pie graph", + "pie chart", + "piece", + "quarters", + "fourths", + "pizzas", + "cakes" + ], + "group": "data", + "related": [] + }, + "icon-paper-plane-alt": { + "thesaurus": [ + "paper aeroplane", + "paper airplane", + "sending", + "sends", + "sent", + "delivers" + ], + "group": "item household", + "related": [ + "icon-paper-plane" + ] + }, + "icon-notepad": { + "thesaurus": [ + "notebook", + "text", + "txt" + ], + "group": "item workplace", + "related": [] + }, + "icon-navigation-bottom": { + "thesaurus": [ + "last", + "end", + "arrows", + "triangles" + ], + "group": "action arrow", + "related": [ + "icon-page-up", + "icon-page-down", + "icon-navigation-top" + ] + }, + "icon-meeting": { + "thesaurus": [ + "boardroom", + "table", + "dinner" + ], + "group": "user", + "related": [] + }, + "icon-keyboard": { + "thesaurus": [ + "type", + "inputs" + ], + "group": "item tech hardware", + "related": [] + }, + "icon-load": { + "thesaurus": [ + "downloads" + ], + "group": "action arrow", + "related": [ + "icon-navigation-bottom" + ] + }, + "icon-receipt-dollar": { + "thesaurus": [], + "group": "item money receipt", + "related": [ + "icon-receipt-yen", + "icon-receipt-pound", + "icon-receipt-euro", + "icon-receipt-alt" + ] + }, + "icon-previous": { + "thesaurus": [ + "arrows", + "triangles" + ], + "group": "action arrow", + "related": [] + }, + "icon-pictures": { + "thesaurus": [ + "photograph", + "photography", + "image", + "picture", + "cameras" + ], + "group": "picture", + "related": [ + "icon-picture", + "icon-umb-media", + "icon-pictures-alt", + "icon-pictures-alt-2", + "icon-photo-album" + ] + }, + "icon-notepad-alt": { + "thesaurus": [], + "group": "item workplace", + "related": [] + }, + "icon-paper-bag": { + "thesaurus": [ + "carrier", + "container", + "sack" + ], + "group": "", + "related": [] + }, + "icon-name-badge": { + "thesaurus": [ + "brooch", + "sheriff", + "sticker" + ], + "group": "", + "related": [] + }, + "icon-medicine": { + "thesaurus": [ + "bottles", + "pills", + "medicines" + ], + "group": "item household", + "related": [ + "icon-medical-emergency" + ] + }, + "icon-list": { + "thesaurus": [ + "menus", + "hamburgers", + "three", + "3", + "catalogue", + "catalog", + "inventory", + "record" + ], + "group": "shape box layout", + "related": [ + "icon-thumbnails", + "icon-thumbnails-small", + "icon-thumbnail-list", + "icon-umb-contour" + ] + }, + "icon-key": { + "thesaurus": [ + "key", + "lock", + "house", + "home" + ], + "group": "item security", + "related": [ + "icon-lock", + "icon-keyhole", + "icon-old-key", + "icon-keychain", + "icon-key" + ] + }, + "icon-receipt-alt": { + "thesaurus": [], + "group": "item money receipt", + "related": [ + "icon-receipt-yen", + "icon-receipt-pound", + "icon-receipt-euro", + "icon-receipt-dollar" + ] + }, + "icon-previous-media": { + "thesaurus": [ + "rewind", + "skip" + ], + "group": "item media", + "related": [ + "icon-next-media" + ] + }, + "icon-pictures-alt": { + "thesaurus": [ + "photograph", + "image", + "picture", + "mountains", + "scenery", + "landscape" + ], + "group": "picture", + "related": [ + "icon-picture", + "icon-pictures", + "icon-umb-media", + "icon-pictures-alt-2", + "icon-photo-album", + "icon-mountain" + ] + }, + "icon-pants": { + "thesaurus": [ + "trousers" + ], + "group": "item clothing", + "related": [] + }, + "icon-nodes": { + "thesaurus": [ + "git", + "line", + "graph" + ], + "group": "data", + "related": [] + }, + "icon-music": { + "thesaurus": [ + "notes", + "musical", + "sounds" + ], + "group": "item media", + "related": [] + }, + "icon-readonly": { + "thesaurus": [ + "uneditable" + ], + "group": "action", + "related": [] + }, + "icon-presentation": { + "thesaurus": [ + "audience", + "talks", + "powerpoints", + "slideshows", + "keynotes", + "speakers", + "conference" + ], + "group": "item workplace", + "related": [] + }, + "icon-pictures-alt-2": { + "thesaurus": [ + "photograph", + "image", + "picture", + "mountains", + "scenery", + "landscape" + ], + "group": "picture", + "related": [ + "icon-picture", + "icon-pictures", + "icon-pictures-alt", + "icon-umb-media", + "icon-photo-album", + "icon-mountain" + ] + }, + "icon-pannel-close": { + "thesaurus": [ + "panels", + "down", + "triangles", + "minimize", + "minimise" + ], + "group": "action window", + "related": [ + "icon-panel-show" + ] + }, + "icon-next": { + "thesaurus": [ + "right", + "triangles", + "forwards" + ], + "group": "action arrow", + "related": [ + "icon-play" + ] + }, + "icon-multiple-windows": { + "thesaurus": [ + "stacked", + "minimize", + "restore" + ], + "group": "action window", + "related": [] + }, + "icon-medical-emergency": { + "thesaurus": [ + "medicine", + "hospitals", + "ambulances", + "health" + ], + "group": "logo", + "related": [ + "icon-medicine" + ] + }, + "icon-medal": { + "thesaurus": [ + "awards", + "prizes", + "stars", + "heroes" + ], + "group": "item award", + "related": [ + "icon-diploma", + "icon-diploma-alt", + "icon-trophy" + ] + }, + "icon-link": { + "thesaurus": [ + "chains", + "links", + "hyperlinks" + ], + "group": "item tech", + "related": [] + }, + "icon-linux-tux": { + "thesaurus": [ + "penguins" + ], + "group": "logo", + "related": [ + "icon-os-x" + ] + }, + "icon-junk": { + "thesaurus": [ + "trash", + "recycling bin", + "recycle bin", + "bin", + "reuses" + ], + "group": "item household", + "related": [] + }, + "icon-item-arrangement": { + "thesaurus": [ + "rows", + "grid", + "boxes", + "squares", + "six", + "6" + ], + "group": "shape box layout", + "related": [ + "icon-thumbnails", + "icon-grid", + "icon-stop", + "icon-thumbnail-list", + "icon-item-arrangement" + ] + }, + "icon-iphone": { + "thesaurus": [ + "mobiles", + "telephones", + "cellphones", + "cell phones" + ], + "group": "item household phone", + "related": [ + "icon-old-phone", + "icon-phone", + "icon-phone-ring" + ] + }, + "icon-lightning": { + "thesaurus": [ + "storms", + "electricity" + ], + "group": "weather cloud", + "related": [] + }, + "icon-map": { + "thesaurus": [ + "partitions", + "screens", + "leaflets", + "flyers" + ], + "group": "item globe", + "related": [] + }, + "icon-multiple-credit-cards": { + "thesaurus": [ + "payments", + "debit cards", + "credit cards", + "contactless", + "cashless", + "loyalty cards", + "store cards", + "business cards" + ], + "group": "item money card", + "related": [ + "icon-credit-card", + "icon-credit-card-alt", + "icon-multiple-credit-cards" + ] + }, + "icon-next-media": { + "thesaurus": [ + "fast forward", + "skip" + ], + "group": "item media", + "related": [ + "icon-previous-media" + ] + }, + "icon-panel-show": { + "thesaurus": [ + "panels", + "up", + "triangles", + "maximize", + "maximise", + "expand" + ], + "group": "action window", + "related": [ + "icon-pannel-close" + ] + }, + "icon-picture": { + "thesaurus": [ + "photograph", + "image", + "picture", + "mountains", + "scenery", + "landscape" + ], + "group": "picture", + "related": [ + "icon-umb-media", + "icon-pictures", + "icon-pictures-alt", + "icon-pictures-alt-2", + "icon-photo-album", + "icon-mountain" + ] + }, + "icon-power": { + "thesaurus": [ + "shut down", + "on", + "off" + ], + "group": "item tech", + "related": [] + }, + "icon-re-post": { + "thesaurus": [ + "retweet", + "share", + "repost" + ], + "group": "action arrow", + "related": [ + "icon-axis-rotation", + "icon-axis-rotation-2", + "icon-axis-rotation-3", + "icon-sync", + "icon-refresh" + ] + }, + "icon-rate": { + "thesaurus": [ + "stars" + ], + "group": "shape", + "related": [] + }, + "icon-rain": { + "thesaurus": [ + "raining", + "precipitation" + ], + "group": "weather cloud", + "related": [] + }, + "icon-radio": { + "thesaurus": [ + "broadcast", + "tv", + "fm", + "television", + "aerials", + "ariels", + "transmitters", + "podcasts" + ], + "group": "item tech hardware", + "related": [ + "icon-radio-alt", + "icon-radio-receiver" + ] + }, + "icon-radio-receiver": { + "thesaurus": [ + "broadcast", + "tv", + "fm", + "television", + "receivers", + "podcasts", + "retro" + ], + "group": "item tech hardware", + "related": [ + "icon-radio-alt", + "icon-radio" + ] + }, + "icon-radio-alt": { + "thesaurus": [ + "broadcast", + "tv", + "fm", + "television", + "aerials", + "ariels", + "transmitters", + "podcasts" + ], + "group": "item tech hardware", + "related": [ + "icon-radio-alt", + "icon-radio-receiver" + ] + }, + "icon-quote": { + "thesaurus": [ + "quotation marks", + "speech marks", + "speakers", + "talks", + "quotes", + "talking", + "chatting", + "testimonials" + ], + "group": "misc", + "related": [] + }, + "icon-qr-code": { + "thesaurus": [ + "barcode", + "qr codes" + ], + "group": "item tech", + "related": [] + }, + "icon-pushpin": { + "thesaurus": [ + "map pins", + "thumb tack", + "noticeboard" + ], + "group": "item workplace", + "related": [] + }, + "icon-pulse": { + "thesaurus": [ + "heartbeat", + "health", + "line charts", + "monitors", + "line graphs" + ], + "group": "data", + "related": [] + }, + "icon-projector": { + "thesaurus": [ + "home cinema", + "slideshows", + "presentations" + ], + "group": "item media", + "related": [] + }, + "icon-play": { + "thesaurus": [ + "right", + "arrows", + "triangles", + "continue" + ], + "group": "item media", + "related": [ + "icon-next" + ] + }, + "icon-playing-cards": { + "thesaurus": [ + "slideshows", + "carousels", + "poker", + "card games", + "playing cards" + ], + "group": "misc game", + "related": [] + }, + "icon-playlist": { + "thesaurus": [ + "music", + "musical notes" + ], + "group": "item media", + "related": [] + }, + "icon-plugin": { + "thesaurus": [ + "puzzle piece", + "jigsaws", + "games", + "kids", + "children", + "plugins", + "plug-ins", + "extensions", + "packages" + ], + "group": "misc game", + "related": [] + }, + "icon-podcast": { + "thesaurus": [ + "person", + "users", + "people" + ], + "group": "user special", + "related": [] + }, + "icon-poker-chip": { + "thesaurus": [ + "1", + "one", + "coins", + "money", + "cash", + "change", + "poker chips" + ], + "group": "misc game", + "related": [] + }, + "icon-poll": { + "thesaurus": [ + "bar graphs", + "bar charts" + ], + "group": "data", + "related": [] + }, + "icon-post-it": { + "thesaurus": [ + "postits", + "post-its", + "post its", + "labels", + "stickers", + "notes", + "pages", + "sheets" + ], + "group": "document", + "related": [] + }, + "icon-pound-bag": { + "thesaurus": [ + "cash", + "swag" + ], + "group": "item money bag", + "related": [] + }, + "icon-power-outlet": { + "thesaurus": [ + "power sockets", + "power outlets", + "electric", + "electricity" + ], + "group": "item household", + "related": [] + }, + "icon-photo-album": { + "thesaurus": [ + "books", + "photo albums" + ], + "group": "picture", + "related": [] + }, + "icon-phone": { + "thesaurus": [ + "telephones", + "phones", + "calling" + ], + "group": "item household phone", + "related": [] + }, + "icon-phone-ring": { + "thesaurus": [ + "telephones", + "phones", + "calling" + ], + "group": "item household phone", + "related": [] + }, + "icon-people": { + "thesaurus": [ + "person", + "man", + "men", + "male" + ], + "group": "user", + "related": [] + }, + "icon-people-female": { + "thesaurus": [ + "person", + "people", + "woman", + "female", + "women" + ], + "group": "user", + "related": [] + }, + "icon-people-alt": { + "thesaurus": [ + "person", + "man", + "men", + "male" + ], + "group": "user", + "related": [] + }, + "icon-people-alt-2": { + "thesaurus": [ + "person", + "man", + "men", + "male" + ], + "group": "user", + "related": [] + }, + "icon-pc": { + "thesaurus": [ + "computers", + "servers", + "desktops", + "pcs" + ], + "group": "item tech hardware", + "related": [] + }, + "icon-pause": { + "thesaurus": [], + "group": "item media", + "related": [] + }, + "icon-path": { + "thesaurus": [ + "routes", + "paths", + "winding" + ], + "group": "action arrow", + "related": [] + }, + "icon-out": { + "thesaurus": [ + "export", + "external", + "arrows" + ], + "group": "action arrow box", + "related": [] + }, + "icon-outbox": { + "thesaurus": [ + "out tray", + "trays" + ], + "group": "item workplace", + "related": [] + }, + "icon-outdent": { + "thesaurus": [ + "move", + "indentation", + "padding", + "spacing", + "margin" + ], + "group": "action arrow box", + "related": [ + "icon-indent" + ] + }, + "icon-page-add": { + "thesaurus": [ + "new", + "create", + "documents", + "pages" + ], + "group": "document", + "related": [] + }, + "icon-page-down": { + "thesaurus": [ + "bottom" + ], + "group": "action arrow box", + "related": [ + "icon-page-up", + "icon-navigation-top", + "icon-navigation-bottom" + ] + }, + "icon-page-remove": { + "thesaurus": [ + "delete", + "documents", + "pages" + ], + "group": "document", + "related": [] + }, + "icon-page-restricted": { + "thesaurus": [ + "documents", + "pages", + "disabled", + "restricted" + ], + "group": "document", + "related": [] + }, + "icon-page-up": { + "thesaurus": [ + "top" + ], + "group": "action arrow box", + "related": [ + "icon-page-down", + "icon-navigation-top", + "icon-navigation-bottom" + ] + }, + "icon-paint-roller": { + "thesaurus": [ + "decorate", + "decoration", + "decorating", + "themes", + "theming", + "colour", + "color", + "paint" + ], + "group": "item household", + "related": [] + }, + "icon-palette": { + "thesaurus": [ + "artist", + "painting", + "painter", + "themes", + "theming", + "colour", + "color", + "paint" + ], + "group": "item household", + "related": [] + }, + "icon-newspaper": { + "thesaurus": [ + "blogs", + "articles", + "journalism", + "journalist", + "press", + "media", + "magazine" + ], + "group": "item household", + "related": [] + }, + "icon-newspaper-alt": { + "thesaurus": [ + "blogs", + "articles", + "journalism", + "journalist", + "press", + "media", + "magazine" + ], + "group": "item household", + "related": [] + }, + "icon-network-alt": { + "thesaurus": [ + "graphs", + "charts", + "networks", + "trees", + "hierarchy", + "flowcharts", + "flow charts", + "branches", + "paths", + "forks" + ], + "group": "data", + "related": [ + "icon-mindmap" + ] + }, + "icon-navigational-arrow": { + "thesaurus": [ + "satnav", + "sat nav", + "satellite navigation", + "gps" + ], + "group": "action arrow", + "related": [] + }, + "icon-navigation": { + "thesaurus": [ + "move", + "drag and drop", + "drag & drop", + "pan" + ], + "group": "action arrow", + "related": [] + }, + "icon-navigation-vertical": { + "thesaurus": [ + "up", + "down", + "scroll" + ], + "group": "action arrow", + "related": [] + }, + "icon-navigation-up": { + "thesaurus": [ + "triangles", + "arrows" + ], + "group": "action arrow", + "related": [ + "icon-navigation-right" + ] + }, + "icon-navigation-top": { + "thesaurus": [ + "start", + "top", + "arrows", + "triangles" + ], + "group": "action arrow box", + "related": [ + "icon-page-up", + "icon-page-down", + "icon-navigation-bottom" + ] + }, + "icon-navigation-road": { + "thesaurus": [], + "group": "action arrow", + "related": [] + }, + "icon-navigation-right": { + "thesaurus": [ + "arrows", + "triangles" + ], + "group": "action arrow", + "related": [ + "icon-navigation-up" + ] + }, + "icon-microscope": { + "thesaurus": [ + "science", + "lab" + ], + "group": "item", + "related": [ + "icon-lab" + ] + }, + "icon-mindmap": { + "thesaurus": [ + "chart", + "flow chart", + "diagram", + "decision tree" + ], + "group": "data", + "related": [] + }, + "icon-molecular-network": { + "thesaurus": [ + "molecule", + "atoms", + "network", + "hub" + ], + "group": "misc", + "related": [ + "icon-molecular" + ] + }, + "icon-molecular": { + "thesaurus": [ + "molecule", + "atoms", + "network", + "hub", + "virus" + ], + "group": "misc", + "related": [ + "icon-molecular-network" + ] + }, + "icon-mountain": { + "thesaurus": [ + "landscape", + "geography", + "nature", + "natural feature" + ], + "group": "item nature", + "related": [] + }, + "icon-mouse-cursor": { + "thesaurus": [ + "cursors", + "pointers", + "arrows", + "mouse", + "mice" + ], + "group": "action arrow", + "related": [] + }, + "icon-mouse": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-movie-alt": { + "thesaurus": [ + "movies", + "films", + "hollywood", + "action", + "clapperboards", + "filmmaking", + "directors", + "crew" + ], + "group": "item", + "related": [] + }, + "icon-map-marker": { + "thesaurus": [ + "pins", + "maps", + "markers", + "locations", + "lollipop", + "lolly" + ], + "group": "misc", + "related": [] + }, + "icon-movie": { + "thesaurus": [ + "movies", + "films", + "reels" + ], + "group": "item", + "related": [] + }, + "icon-map-loaction": { + "thesaurus": [], + "group": "item", + "related": [] + }, + "icon-map-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-male-symbol": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-male-and-female": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-mailbox": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-magnet": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-loupe": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-mobile": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-logout": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-log-out": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-layers": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-left-double-arrow": { + "thesaurus": [ + "chevrons", + "arrows", + "backwards" + ], + "group": "action arrow", + "related": [] + }, + "icon-layout": { + "thesaurus": [ + "media", + "newspaper", + "layouts", + "magazines" + ], + "group": "shape box layout", + "related": [] + }, + "icon-legal": { + "thesaurus": [ + "scales", + "weight", + "mass", + "compare", + "balance" + ], + "group": "item household", + "related": [ + "icon-weight" + ] + }, + "icon-lense": { + "thesaurus": [ + "circles", + "orbits", + "planets", + "eyeballs", + "target" + ], + "group": "item", + "related": [] + }, + "icon-library": { + "thesaurus": [ + "temple", + "institution", + "government" + ], + "group": "building", + "related": [ + "icon-school" + ] + }, + "icon-light-down": { + "thesaurus": [ + "brightness" + ], + "group": "", + "related": [] + }, + "icon-light-up": { + "thesaurus": [ + "brightness" + ], + "group": "", + "related": [] + }, + "icon-lightbulb-active": { + "thesaurus": [ + "on", + "switch", + "lamps", + "bulbs", + "lights" + ], + "group": "item household", + "related": [] + }, + "icon-lightbulb": { + "thesaurus": [ + "off", + "lights", + "bulbs", + "lamps" + ], + "group": "item household", + "related": [] + }, + "icon-ipad": { + "thesaurus": [ + "tablet" + ], + "group": "", + "related": [] + }, + "icon-invoice": { + "thesaurus": [ + "bills", + "invoices", + "dollar", + "usd", + "currency" + ], + "group": "item money invoice", + "related": [] + }, + "icon-info": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-infinity": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-indent": { + "thesaurus": [ + "move", + "indentation", + "padding", + "spacing", + "margin" + ], + "group": "action arrow box", + "related": [ + "icon-outdent" + ] + }, + "icon-inbox": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-inbox-full": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-inactive-line": { + "thesaurus": [ + "slashes", + "backslashes", + "lines", + "disabled", + "crossed" + ], + "group": "shape", + "related": [] + }, + "icon-imac": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-hourglass": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-home": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-grid": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-food": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-favorite": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-door-open-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-diagnostics": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-contrast": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coins-dollar-alt": { + "thesaurus": [ + "money", + "us", + "usa" + ], + "group": "", + "related": [] + }, + "icon-circle-dotted-active": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-cinema": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-chip": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-chip-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-chess": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-checkbox": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-checkbox-empty": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-checkbox-dotted": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-checkbox-dotted-active": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-check": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-chat": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-chat-active": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-chart": { + "thesaurus": [ + "lines", + "graphs", + "charts", + "stocks", + "finance", + "financial" + ], + "group": "data", + "related": [] + }, + "icon-chart-curve": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-certificate": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-categories": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-cash-register": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-car": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-caps-lock": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-candy": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-circle-dotted": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-circuits": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-circus": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-client": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-clothes-hanger": { + "thesaurus": [ + "clothes", + "clothing", + "wardrobes" + ], + "group": "item clothing", + "related": [] + }, + "icon-cloud-drive": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-cloud-upload": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-cloud": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-cloudy": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-clubs": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-cocktail": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-code": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coffee": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coin-dollar": { + "thesaurus": [ + "money", + "us", + "usa", + "paper", + "cash" + ], + "group": "", + "related": [] + }, + "icon-coin-pound": { + "thesaurus": [ + "money", + "sterling", + "cash" + ], + "group": "", + "related": [] + }, + "icon-coin-yen": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coin": { + "thesaurus": [ + "money", + "cash" + ], + "group": "", + "related": [] + }, + "icon-coins-alt": { + "thesaurus": [ + "money", + "cash" + ], + "group": "", + "related": [] + }, + "icon-console": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-connection": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-compress": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-company": { + "thesaurus": [ + "city", + "cities", + "towns", + "companies", + "sky scrapers", + "buildings", + "offices" + ], + "group": "building", + "related": [] + }, + "icon-command": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coin-euro": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-combination-lock": { + "thesaurus": [], + "group": "", + "related": [ + "icon-combination-lock-open", + "icon-lock", + "icon-keyhole", + "icon-old-key", + "icon-keychain", + "icon-key" + ] + }, + "icon-combination-lock-open": { + "thesaurus": [], + "group": "", + "related": [ + "icon-combination-lock", + "icon-unlocked", + "icon-keyhole", + "icon-old-key", + "icon-keychain", + "icon-key" + ] + }, + "icon-comb": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-columns": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-colorpicker": { + "thesaurus": [ + "pipettes", + "eyedroppers", + "eye droppers", + "eye-droppers", + "color pickers", + "colour pickers", + "colorpickers", + "colourpickers", + "styles" + ], + "group": "item", + "related": [] + }, + "icon-color-bucket": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coins": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coins-yen": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coins-yen-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coins-pound": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coins-pound-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coins-euro": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coins-euro-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coins-dollar": { + "thesaurus": [ + "money", + "us", + "usa", + "cash" + ], + "group": "", + "related": [] + }, + "icon-conversation-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-conversation": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-coverflow": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-credit-card-alt": { + "thesaurus": [ + "payments", + "debit cards", + "credit cards", + "contactless", + "cashless", + "loyalty cards", + "store cards", + "business cards" + ], + "group": "item money card", + "related": [ + "icon-credit-card", + "icon-credit-card-alt", + "icon-multiple-credit-cards" + ] + }, + "icon-credit-card": { + "thesaurus": [ + "payments", + "debit cards", + "credit cards", + "contactless", + "cashless", + "loyalty cards", + "store cards", + "business cards" + ], + "group": "item money card", + "related": [ + "icon-credit-card", + "icon-credit-card-alt", + "icon-multiple-credit-cards" + ] + }, + "icon-crop": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-crosshair": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-crown-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-crown": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-cupcake": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-curve": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-cut": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-dashboard": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-defrag": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-delete": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-delete-key": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-departure": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-desk": { + "thesaurus": [ + "benches", + "desks", + "horses", + "gymnastics", + "hurdles" + ], + "group": "item household", + "related": [] + }, + "icon-desktop": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-donate": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-dollar-bag": { + "thesaurus": [ + "money", + "us", + "usa", + "cash", + "sack" + ], + "group": "", + "related": [] + }, + "icon-documents": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-document": { + "thesaurus": [ + "papers", + "documents", + "pages", + "sheets", + "leaf", + "leaves", + "new", + "blank" + ], + "group": "item", + "related": [] + }, + "icon-document-dashed-line": { + "thesaurus": [ + "documents", + "new", + "create", + "pages", + "papers", + "drafts" + ], + "group": "document", + "related": [] + }, + "icon-dock-connector": { + "thesaurus": [ + "usb", + "apple", + "30-pin", + "adaptor", + "cable", + "charges", + "charging" + ], + "group": "item tech", + "related": [] + }, + "icon-dna": { + "thesaurus": [ + "biology", + "id", + "identity" + ], + "group": "item science", + "related": [] + }, + "icon-display": { + "thesaurus": [ + "displays", + "monitors", + "screens", + "tvs", + "televisions", + "computers", + "pcs" + ], + "group": "item tech hardware", + "related": [] + }, + "icon-disk-image": { + "thesaurus": [ + "cds", + "dvds", + "disk", + "disc", + "drive" + ], + "group": "item tech hardware", + "related": [] + }, + "icon-disc": { + "thesaurus": [ + "cds", + "discs", + "disks", + "record", + "dvds", + "blurays", + "bluerays", + "blu-rays", + "blue rays", + "blue-rays", + "movies", + "films", + "music" + ], + "group": "item tech", + "related": [] + }, + "icon-directions": { + "thesaurus": [ + "signs", + "signposts" + ], + "group": "item", + "related": [] + }, + "icon-directions-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-diploma": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-diploma-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-dice": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-diamonds": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-diamond": { + "thesaurus": [ + "diamonds", + "gems", + "special", + "expensive", + "commodities", + "commodity", + "precious", + "valuable" + ], + "group": "item money", + "related": [] + }, + "icon-diagonal-arrow": { + "thesaurus": [ + "arrows", + "grows", + "expands", + "bigger" + ], + "group": "action arrow", + "related": [ + "icon-diagonal-arrow-alt" + ] + }, + "": { + "thesaurus": [ + "arrows", + "grows", + "expands", + "bigger" + ], + "group": "action arrow", + "related": [ + "icon-diagonal-arrow" + ] + }, + "icon-door-open": { + "thesaurus": [ + "doors", + "entrances", + "exits", + "log out", + "logout", + "log in", + "login" + ], + "group": "item", + "related": [] + }, + "icon-download-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-download": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-drop": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-eco": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-economy": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-edit": { + "thesaurus": [ + "pencils", + "pens", + "edits", + "writers", + "authors", + "writes" + ], + "group": "item", + "related": [] + }, + "icon-eject": { + "thesaurus": [ + "ejects", + "up", + "top" + ], + "group": "action arrow box", + "related": [] + }, + "icon-employee": { + "thesaurus": [], + "group": "user special", + "related": [ + "icon-user", + "icon-user-female", + "icon-umb-users", + "icon-user-glasses", + "icon-client", + "icon-employee", + "icon-piracy", + "icon-theif", + "icon-operator" + ] + }, + "icon-energy-saving-bulb": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-enter": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-equalizer": { + "thesaurus": [ + "equalizers", + "equaliser", + "equalisers", + "settings", + "options", + "configuration" + ], + "group": "item tech hardware", + "related": [] + }, + "icon-escape": { + "thesaurus": [ + "out", + "escapes", + "exits" + ], + "group": "action arrow circle", + "related": [] + }, + "icon-ethernet": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-euro-bag": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-exit-fullscreen": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-eye": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-facebook-like": { + "thesaurus": [ + "thumbs up", + "likes", + "social media" + ], + "group": "item hand thumb", + "related": [] + }, + "icon-factory": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-font": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-folders": { + "thesaurus": [ + "files", + "documents", + "storage", + "library", + "components" + ], + "group": "item workplace", + "related": [] + }, + "icon-folder": { + "thesaurus": [ + "folders", + "filing", + "documents", + "stroage" + ], + "group": "item workplace", + "related": [] + }, + "icon-folder-outline": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-folder-open": { + "thesaurus": [ + "filing", + "documents" + ], + "group": "item workplace", + "related": [] + }, + "icon-flowerpot": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-flashlight": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-flash": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-flag": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-flag-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-firewire": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-firewall": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-fire": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-fingerprint": { + "thesaurus": [ + "fingerprints", + "crimes", + "criminals", + "id", + "identification", + "biometrics" + ], + "group": "item security", + "related": [] + }, + "icon-filter": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-filter-arrows": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-files": { + "thesaurus": [ + "storage", + "filing", + "filing cabinets", + "repository", + "repositories" + ], + "group": "item workplace", + "related": [] + }, + "icon-file-cabinet": { + "thesaurus": [ + "filing cabinets", + "offices", + "drawers", + "storage" + ], + "group": "item workplace", + "related": [] + }, + "icon-female-symbol": { + "thesaurus": [ + "woman", + "women", + "females", + "sexes", + "genders" + ], + "group": "misc", + "related": [] + }, + "icon-footprints": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-hammer": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-hand-active-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-forking": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-hand-active": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-hand-pointer-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-hand-pointer": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-handprint": { + "thesaurus": [ + "hands", + "personalisation", + "personalization", + "ids", + "profiles" + ], + "group": "item hand", + "related": [] + }, + "icon-handshake": { + "thesaurus": [ + "meetings", + "handshakes", + "greetings", + "business" + ], + "group": "item hand", + "related": [] + }, + "icon-handtool": { + "thesaurus": [ + "hands", + "grabs", + "cursor" + ], + "group": "item hand", + "related": [] + }, + "icon-hard-drive": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-help": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-graduate": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-gps": { + "thesaurus": [ + "satellites", + "space", + "satnav", + "sat nav", + "satellite navigation", + "gps" + ], + "group": "item tech hardware", + "related": [] + }, + "icon-help-alt": { + "thesaurus": [ + "questions", + "question marks", + "assistance" + ], + "group": "misc", + "related": [] + }, + "icon-height": { + "thesaurus": [ + "heights", + "distances", + "spaces", + "spacing", + "vertical" + ], + "group": "action arrow box", + "related": [] + }, + "icon-globe": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-hearts": { + "thesaurus": [ + "love", + "care", + "caring", + "health" + ], + "group": "shape", + "related": [] + }, + "icon-globe-inverted-europe-africa": { + "thesaurus": [ + "planets", + "earth", + "world" + ], + "group": "item globe", + "related": [] + }, + "icon-headset": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-globe-inverted-asia": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-headphones": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-globe-inverted-america": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-hd": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-globe-europe---africa": { + "thesaurus": [ + "planets", + "earth", + "world" + ], + "group": "item globe", + "related": [] + }, + "icon-hat": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-globe-asia": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-globe-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-hard-drive-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-glasses": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-gift": { + "thesaurus": [ + "gifts", + "presents", + "christmas", + "birthdays", + "giving", + "rewards", + "surprises" + ], + "group": "item", + "related": [] + }, + "icon-handtool-alt": { + "thesaurus": [ + "hands", + "grabs", + "cursor" + ], + "group": "item hand", + "related": [] + }, + "icon-geometry": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-game": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-fullscreen": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-fullscreen-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-frame": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-frame-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-camera-roll": { + "thesaurus": [ + "films", + "cameras" + ], + "group": "item tech", + "related": [] + }, + "icon-bookmark": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bill": { + "thesaurus": [ + "currency", + "money", + "notes", + "one", + "1", + "bills" + ], + "group": "item money note", + "related": [] + }, + "icon-baby-stroller": { + "thesaurus": [ + "pram", + "pushchair" + ], + "group": "", + "related": [] + }, + "icon-alarm-clock": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-adressbook": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-add": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-activity": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-untitled": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-camcorder": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-calendar": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-calendar-alt": { + "thesaurus": [ + "dates", + "calendars", + "events" + ], + "group": "item", + "related": [] + }, + "icon-calculator": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bus": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-burn": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bulleted-list": { + "thesaurus": [ + "bulletpoints", + "bullets", + "ul", + "lists" + ], + "group": "shape box layout", + "related": [] + }, + "icon-bug": { + "thesaurus": [ + "ladybugs", + "lady bugs", + "ladybirds", + "lady birds", + "bugs", + "insects", + "minibeasts", + "wildlife", + "issues" + ], + "group": "item nature", + "related": [] + }, + "icon-brush": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-brush-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-brush-alt-2": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-browser-window": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-briefcase": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-brick": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-brackets": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-box": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-box-open": { + "thesaurus": [ + "boxes", + "storage", + "dropbox", + "packages", + "parcels", + "packaging", + "opens" + ], + "group": "item", + "related": [] + }, + "icon-box-alt": { + "thesaurus": [ + "filing", + "boxes", + "storage" + ], + "group": "item workplace", + "related": [] + }, + "icon-books": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-billboard": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bills-dollar": { + "thesaurus": [ + "money", + "us", + "usa", + "paper", + "cash" + ], + "group": "", + "related": [] + }, + "icon-bills-euro": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bills-pound": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bills-yen": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bills": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-binarycode": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-binoculars": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bird": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-birthday-cake": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-blueprint": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-block": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bluetooth": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-boat-shipping": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bomb": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-book-alt-2": { + "thesaurus": [ + "books", + "reading", + "documentation", + "library" + ], + "group": "item", + "related": [] + }, + "icon-bones": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-book-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-book": { + "thesaurus": [ + "books", + "dictionary", + "dictionaries", + "thesaurus", + "thesauruses", + "library", + "authors", + "manuals" + ], + "group": "item", + "related": [] + }, + "icon-bill-yen": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-award": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bill-pound": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-autofill": { + "thesaurus": [ + "edits", + "editing", + "editor", + "writes", + "writing", + "text boxes", + "textboxes", + "pencils", + "pens" + ], + "group": "action", + "related": [] + }, + "icon-bill-euro": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-auction-hammer": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bill-dollar": { + "thesaurus": [ + "money", + "us", + "usa", + "paper", + "cash" + ], + "group": "", + "related": [] + }, + "icon-attachment": { + "thesaurus": [ + "paperclips", + "clippy", + "attachments", + "stationery" + ], + "group": "item workplace", + "related": [] + }, + "icon-bell": { + "thesaurus": [ + "bells", + "notifications", + "alerts" + ], + "group": "item", + "related": [] + }, + "icon-article": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bell-off": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-art-easel": { + "thesaurus": [ + "artworks", + "painting", + "paints", + "artist", + "gallary" + ], + "group": "picture", + "related": [] + }, + "icon-beer-glass": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-arrow-up": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-battery-low": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-arrow-right": { + "thesaurus": [ + "arrows", + "forwards" + ], + "group": "action arrow", + "related": [] + }, + "icon-battery-full": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-arrow-left": { + "thesaurus": [ + "arrows", + "back" + ], + "group": "action arrow", + "related": [] + }, + "icon-bars": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-arrow-down": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-barcode": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-arrivals": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-bar-chart": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-application-window": { + "thesaurus": [ + "screen", + "window", + "sidebar" + ], + "group": "action window", + "related": [ + "icon-application-window-alt", + "icon-application-error", + "icon-section" + ] + }, + "icon-band-aid": { + "thesaurus": [ + "bandaids", + "plasters", + "band aids", + "health", + "first aid", + "medical" + ], + "group": "item household", + "related": [] + }, + "icon-application-window-alt": { + "thesaurus": [ + "screen", + "window" + ], + "group": "action window", + "related": [ + "icon-application-window", + "icon-application-error", + "icon-section" + ] + }, + "icon-ball": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-application-error": { + "thesaurus": [ + "screen", + "window", + "404", + "500", + "page not found", + "server error", + "fault" + ], + "group": "action window", + "related": [ + "icon-application-window-alt", + "icon-application", + "icon-section" + ] + }, + "icon-badge-restricted": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-app": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-badge-remove": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-anchor": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-badge-count": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-badge-add": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-alert": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-backspace": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-alert-alt": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-addressbook": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-badge": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-chevron-down": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-chevron-up": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-folder-close": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-globe-europe-africa": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-map-location": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-panel-close": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-science": { + "thesaurus": [], + "group": "", + "related": [] + }, + "icon-section": { + "thesaurus": [ + "screen", + "window", + "sidebar" + ], + "group": "action window", + "related": [ + "icon-application-window-alt", + "icon-application-error", + "icon-application" + ] + }, + "icon-traffic": { + "thesaurus": [ + "arrows", + "left", + "right", + "bi-directional", + "two", + "2", + "swap", + "loop", + "reverse", + "navigation" + ], + "group": "action arrow", + "related": [ + "icon-traffic-alt", + "icon-tab-key", + "icon-shuffle", + "icon-repeat", + "icon-repeat-one", + "icon-navigation-road" + ] + } +} \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/devops/importmap/index.js b/src/Umbraco.Web.UI.Client/devops/importmap/index.js new file mode 100644 index 0000000000..3ea95ebf89 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/importmap/index.js @@ -0,0 +1,28 @@ +import { packageJsonExports, packageJsonName } from '../package/index.js'; + +export const createImportMap = (args) => { + const imports = { + ...args.additionalImports, + }; + + // Iterate over the exports in package.json + for (const [key, value] of Object.entries(packageJsonExports || {})) { + // remove leading ./ + if (value && value.endsWith('.js')) { + const moduleName = key.replace(/^\.\//, ''); + + // replace ./dist-cms with src and remove /index.js + let modulePath = value; + if (typeof args.rootDir !== 'undefined') modulePath = modulePath.replace(/^\.\/dist-cms/, args.rootDir); + if (args.replaceModuleExtensions) modulePath = modulePath.replace('.js', '.ts'); + console.log('replacing', value, 'with', modulePath); + const importAlias = `${packageJsonName}/${moduleName}`; + + imports[importAlias] = modulePath; + } + } + + return { + imports, + }; +}; diff --git a/src/Umbraco.Web.UI.Client/devops/json-schema-generator/index.js b/src/Umbraco.Web.UI.Client/devops/json-schema-generator/index.js new file mode 100644 index 0000000000..b99703317a --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/json-schema-generator/index.js @@ -0,0 +1,22 @@ +import { writeFileSync } from 'fs'; +import { createImportMap } from '../importmap/index.js'; + +const tsPath = './src/json-schema/all-packages.ts'; + +const importmap = createImportMap({ + rootDir: './src', + replaceModuleExtensions: true, +}); + +const paths = Object.keys(importmap.imports); + +const content = ` +${ + paths.map(path => `import '${path}';`).join('\n') +} +`; + +//const config = await resolveConfig('./.prettierrc.json'); +//const formattedContent = await format(content, { ...config, parser: 'json' }); + +writeFileSync(tsPath, content); diff --git a/src/Umbraco.Web.UI.Client/devops/localization/compare-languages.js b/src/Umbraco.Web.UI.Client/devops/localization/compare-languages.js new file mode 100644 index 0000000000..9a532f300f --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/localization/compare-languages.js @@ -0,0 +1,66 @@ +/** + * This script is used to compare the keys in the localization files. It will take a main language (en.js) and compare with the other languages. + * The script will output the keys that are missing in the other languages and the keys that are missing in the main language. + * + * Note: Since the source files are TypeScript files, the script will only compare on the dist-cms files. + * + * Usage: node devops/localization/compare-languages.js [filter] + * Example: node devops/localization/compare-languages.js da-dk.js + * + * Copyright (c) 2024 by Umbraco HQ + */ + +import fs from 'fs'; +import path from 'path'; + +const mainLanguage = 'en.js'; +const __dirname = import.meta.dirname; +const languageFolder = path.join(__dirname, '../../dist-cms/assets/lang'); + +// Check that the languageFolder exists +if (!fs.existsSync(languageFolder)) { + console.error(`The language folder does not exist: ${languageFolder}. You need to build the project first by running 'npm run build'`); + process.exit(1); +} + +const mainKeys = (await import(path.join(languageFolder, mainLanguage))).default; +const mainMap = buildMap(mainKeys); + +const filter = process.argv[2]; +if (filter) { + console.log(`Filtering on: ${filter}`); +} + +const languages = fs.readdirSync(languageFolder).filter((file) => file !== mainLanguage && file.endsWith('.js') && (!filter || file.includes(filter))); +const missingKeysInMain = []; + +const languagePromise = Promise.all(languages.map(async (language) => { + const languageKeys = (await import(path.join(languageFolder, language))).default; + const languageMap = buildMap(languageKeys); + + const missingKeys = Array.from(mainMap.keys()).filter((key) => !languageMap.has(key)); + let localMissingKeysInMain = Array.from(languageMap.keys()).filter((key) => !mainMap.has(key)); + localMissingKeysInMain = localMissingKeysInMain.map((key) => `${key} (${language})`); + missingKeysInMain.push(...localMissingKeysInMain); + + console.log(`\n${language}:`); + console.log(`Missing keys in ${language}:`); + console.log(missingKeys); +})); + +await languagePromise; + +console.log(`Missing keys in ${mainLanguage}:`); +console.log(missingKeysInMain); + +function buildMap(keys) { + const map = new Map(); + + for (const key in keys) { + for (const subKey in keys[key]) { + map.set(`${key}_${subKey}`, keys[key][subKey]); + } + } + + return map; +} diff --git a/src/Umbraco.Web.UI.Client/devops/localization/unused-language-keys.js b/src/Umbraco.Web.UI.Client/devops/localization/unused-language-keys.js new file mode 100644 index 0000000000..f462faf4c3 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/localization/unused-language-keys.js @@ -0,0 +1,64 @@ +/** + * This script is used to find unused language keys in the javascript files. It will take a main language (en.js) and compare with the other languages. + * + * Usage: node devops/localization/unused-language-keys.js + * Example: node devops/localization/unused-language-keys.js + * + * Copyright (c) 2024 by Umbraco HQ + */ +import fs from 'fs'; +import path from 'path'; +import glob from 'tiny-glob'; + +const mainLanguage = 'en.js'; + +const __dirname = import.meta.dirname; +const languageFolder = path.join(__dirname, '../../dist-cms/assets/lang'); + +// Check that the languageFolder exists +if (!fs.existsSync(languageFolder)) { + console.error(`The language folder does not exist: ${languageFolder}. You need to build the project first by running 'npm run build'`); + process.exit(1); +} + +const mainKeys = (await import(path.join(languageFolder, mainLanguage))).default; +const mainMap = buildMap(mainKeys); +const keys = Array.from(mainMap.keys()); +const usedKeys = new Set(); + +const elementAndControllerFiles = await glob(`${__dirname}/../../src/**/*.ts`, { filesOnly: true }); + +console.log(`Checking ${elementAndControllerFiles.length} files for unused keys`); + +// Find all the keys used in the javascript files +const filePromise = Promise.all(elementAndControllerFiles.map(async (file) => { + // Check if each key is in the file (simple) + const fileContent = fs.readFileSync(file, 'utf8'); + keys.forEach((key) => { + if (fileContent.includes(key)) { + usedKeys.add(key); + } + }); +})); + +await filePromise; + +const unusedKeys = Array.from(mainMap.keys()).filter((key) => !usedKeys.has(key)); + +console.log(`\n${mainLanguage}:`); +console.log(`Used keys in ${mainLanguage}:`); +console.log(usedKeys); +console.log(`Unused keys in ${mainLanguage}:`); +console.log(unusedKeys); + +function buildMap(keys) { + const map = new Map(); + + for (const key in keys) { + for (const subKey in keys[key]) { + map.set(`${key}_${subKey}`, keys[key][subKey]); + } + } + + return map; +} diff --git a/src/Umbraco.Web.UI.Client/devops/openapi-ts/openapi-ts.config.js b/src/Umbraco.Web.UI.Client/devops/openapi-ts/openapi-ts.config.js new file mode 100644 index 0000000000..012b35b47c --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/openapi-ts/openapi-ts.config.js @@ -0,0 +1,18 @@ +import { defineConfig } from '@hey-api/openapi-ts'; + +export default defineConfig({ + client: 'fetch', + input: 'https://raw.githubusercontent.com/umbraco/Umbraco-CMS/v15/dev/src/Umbraco.Cms.Api.Management/OpenApi.json', + output: { + path: 'src/external/backend-api/src', + format: 'prettier', + lint: 'eslint', + }, + schemas: false, + services: { + asClass: true, + }, + types: { + enums: 'typescript', + }, +}); diff --git a/src/Umbraco.Web.UI.Client/devops/openapi-ts/openapi-ts.dev.config.js b/src/Umbraco.Web.UI.Client/devops/openapi-ts/openapi-ts.dev.config.js new file mode 100644 index 0000000000..3507acc928 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/openapi-ts/openapi-ts.dev.config.js @@ -0,0 +1,19 @@ +import { defineConfig } from '@hey-api/openapi-ts'; + +export default defineConfig({ + client: 'fetch', + debug: true, + input: 'http://localhost:11000/umbraco/swagger/management/swagger.json', + output: { + path: 'src/external/backend-api/src', + format: 'prettier', + lint: 'eslint', + }, + schemas: false, + services: { + asClass: true, + }, + types: { + enums: 'typescript', + }, +}); diff --git a/src/Umbraco.Web.UI.Client/devops/openapi-ts/openapi-ts.local.config.js b/src/Umbraco.Web.UI.Client/devops/openapi-ts/openapi-ts.local.config.js new file mode 100644 index 0000000000..35a11ca85b --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/openapi-ts/openapi-ts.local.config.js @@ -0,0 +1,19 @@ +import { defineConfig } from '@hey-api/openapi-ts'; + +export default defineConfig({ + client: 'fetch', + debug: true, + input: '../Umbraco.Cms.Api.Management/OpenApi.json', + output: { + path: 'src/external/backend-api/src', + format: 'prettier', + lint: 'eslint', + }, + schemas: false, + services: { + asClass: true, + }, + types: { + enums: 'typescript', + }, +}); diff --git a/src/Umbraco.Web.UI.Client/devops/package/index.js b/src/Umbraco.Web.UI.Client/devops/package/index.js new file mode 100644 index 0000000000..fc8b67368b --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/package/index.js @@ -0,0 +1 @@ +export * from './meta.js'; diff --git a/src/Umbraco.Web.UI.Client/devops/package/meta.js b/src/Umbraco.Web.UI.Client/devops/package/meta.js new file mode 100644 index 0000000000..87a4f64a1c --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/package/meta.js @@ -0,0 +1,7 @@ +import { readFileSync } from 'fs'; + +export const packageJsonPath = 'package.json'; +export const packageJsonData = JSON.parse(readFileSync(packageJsonPath).toString()); +export const packageJsonName = packageJsonData.name; +export const packageJsonVersion = packageJsonData.version; +export const packageJsonExports = packageJsonData.exports; diff --git a/src/Umbraco.Web.UI.Client/devops/package/validate-exports.js b/src/Umbraco.Web.UI.Client/devops/package/validate-exports.js new file mode 100644 index 0000000000..0935771ee7 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/package/validate-exports.js @@ -0,0 +1,26 @@ +import { globSync } from 'glob'; +import { packageJsonExports } from './meta.js'; + +const validateExports = async () => { + const errors = []; + + // Iterate over the exports in package.json + for (const [key, value] of Object.entries(packageJsonExports || {})) { + if (value) { + const jsFiles = await globSync(value); + + // Log an error if the export from the package.json does not exist in the build output + if (jsFiles.length === 0) { + errors.push(`Could not find export: ${key} -> ${value} in the build output.`); + } + } + } + + if (errors.length > 0) { + throw new Error(errors.join('\n')); + } else { + console.log('--- Exports validated successfully. ---'); + } +}; + +validateExports(); diff --git a/src/Umbraco.Web.UI.Client/devops/publish/cleanse-pkg.js b/src/Umbraco.Web.UI.Client/devops/publish/cleanse-pkg.js new file mode 100644 index 0000000000..6ef013fe3b --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/publish/cleanse-pkg.js @@ -0,0 +1,16 @@ +import { readFileSync, writeFileSync } from 'fs'; + +console.log('[Prepublish] Cleansing package.json'); + +const packageFile = './package.json'; +const packageJson = JSON.parse(readFileSync(packageFile, 'utf8')); + +// Remove all DevDependencies +delete packageJson.devDependencies; + +// Rename dependencies to peerDependencies +packageJson.peerDependencies = { ...packageJson.dependencies }; +delete packageJson.dependencies; + +// Write the package.json back to disk +writeFileSync(packageFile, JSON.stringify(packageJson, null, 2), 'utf8'); diff --git a/src/Umbraco.Web.UI.Client/devops/tsc-override/index.js b/src/Umbraco.Web.UI.Client/devops/tsc-override/index.js new file mode 100644 index 0000000000..af146e603b --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/tsc-override/index.js @@ -0,0 +1,111 @@ +// Notice: This script is not perfect and may not work in all cases. ex. it places the override term wrong for async and setter/getter methods. But its a help any way. [NL] + +import ts from 'typescript'; +import path from 'node:path'; +import fs from 'node:fs/promises'; + +const tsconfigPath = './tsconfig.json'; + +const cwd = process.cwd(); + +async function fixOverride() { + const configFile = path.isAbsolute(tsconfigPath) + ? tsconfigPath + : ts.findConfigFile(cwd, ts.sys.fileExists, tsconfigPath); + + if (!configFile) { + console.error('No tsconfig file found for path:', tsconfigPath); + process.exit(1); + } + + const config = ts.readConfigFile(configFile, ts.sys.readFile); + + const { options, fileNames } = ts.parseJsonConfigFileContent( + config.config, + ts.sys, + + // Resolve to the folder where the tsconfig file located + path.dirname(tsconfigPath), + ); + + const program = ts.createProgram({ + rootNames: fileNames, + options, + }); + + if (fileNames.length === 0) { + console.error('No files in the project.', { + fileNames, + options, + }); + + process.exit(1); + } + let emitResult = program.emit(); + + const overrideErrors = ts + .getPreEmitDiagnostics(program) + .concat(emitResult.diagnostics) + .filter((diagnostic) => + [ + // This member must have an 'override' modifier because it overrides a member in the base class '{0}'. + 4114, + // This parameter property must have an 'override' modifier because it overrides a member in base class '{0}' + 4115, + // This member must have an 'override' modifier because it overrides an abstract method that is declared in the base class '{0}'. + 4116, + ].includes(diagnostic.code), + ); + + const sortedErrors = sortErrors(overrideErrors); + + for (const diagnostic of sortedErrors) { + await addOverride(diagnostic); + } +} + +/** + * + * @param {ts.Diagnostic} diagnostic + * @returns {Promise} + */ +async function addOverride(diagnostic) { + const fileContent = (await fs.readFile(diagnostic.file.fileName, 'utf-8')).toString(); + let startIndex = diagnostic.start; + + if (fileContent.slice(0, startIndex).endsWith(' get ')) { + startIndex -= 'get '.length; + } + if (fileContent.slice(0, startIndex).endsWith(' async ')) { + startIndex -= 'async '.length; + } + if (fileContent.slice(0, startIndex).endsWith(' readonly ')) { + startIndex -= 'readonly '.length; + } + + const newFileContent = [fileContent.slice(0, startIndex), 'override ', fileContent.slice(startIndex)].join(''); + await fs.writeFile(diagnostic.file.fileName, newFileContent); +} + +/** + * + * @param {ts.Diagnostic[]} errors + * @returns {ts.Diagnostic[]} + */ +function sortErrors(errors) { + // Sort by file path and start position from end to start + // so we can insert override keyword without changing the start position of other errors in the same file that happen before + return errors.slice(0).sort((a, b) => { + if (a.file && b.file) { + if (a.file.fileName === b.file.fileName) { + return b.start - a.start; + } + + return a.file.fileName.localeCompare(b.file.fileName); + } + + return 0; + }); +} + +fixOverride(); diff --git a/src/Umbraco.Web.UI.Client/devops/tsconfig/index.js b/src/Umbraco.Web.UI.Client/devops/tsconfig/index.js new file mode 100644 index 0000000000..12eb80be95 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/tsconfig/index.js @@ -0,0 +1,74 @@ +import { writeFileSync } from 'fs'; +import { format, resolveConfig } from 'prettier'; +import { createImportMap } from '../importmap/index.js'; + +const tsconfigPath = 'tsconfig.json'; +const tsconfigComment = ` +/* ------------------------------------------------------------------------- + + +DON'T EDIT THIS FILE DIRECTLY. It is generated by /devops/tsconfig/index.js + + + + +--------------------------------------------------------------------------- */ +`; + +const tsConfigBase = { + compilerOptions: { + module: 'esnext', + moduleResolution: 'bundler', + moduleDetection: 'force', + verbatimModuleSyntax: true, + target: 'es2022', + lib: ['es2022', 'dom', 'dom.iterable'], + outDir: './types', + allowSyntheticDefaultImports: true, + experimentalDecorators: true, + forceConsistentCasingInFileNames: true, + useDefineForClassFields: false, + baseUrl: '.', + incremental: true, + skipLibCheck: true, + noImplicitOverride: true, + allowImportingTsExtensions: true, + resolveJsonModule: true, + isolatedModules: true, + noEmit: true, + /* Linting */ + strict: true, + noFallthroughCasesInSwitch: true, + noImplicitReturns: true, + }, + include: ['src/**/*.ts', 'apps/**/*.ts', 'e2e/**/*.ts', 'index.ts', 'storybook/stories/**/*.ts', 'examples/**/*.ts'], + references: [ + { + path: './tsconfig.node.json', + }, + ], +}; + +const importmap = createImportMap({ + rootDir: './src', + additionalImports: { + '@umbraco-cms/internal/test-utils': './utils/test-utils.ts', + }, + replaceModuleExtensions: true, +}); + +const paths = {}; + +for (const [key, value] of Object.entries(importmap.imports)) { + const valueAsArray = [value]; + paths[key] = valueAsArray; +} + +tsConfigBase.compilerOptions.paths = paths; + +const content = tsconfigComment + JSON.stringify(tsConfigBase, null, ' '); + +const config = await resolveConfig('./.prettierrc.json'); +const formattedContent = await format(content, { ...config, parser: 'json' }); + +writeFileSync(tsconfigPath, formattedContent); diff --git a/src/Umbraco.Web.UI.Client/devops/utils/index.js b/src/Umbraco.Web.UI.Client/devops/utils/index.js new file mode 100644 index 0000000000..69244f16a2 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/devops/utils/index.js @@ -0,0 +1,13 @@ +import { writeFile, mkdir } from 'fs'; +import * as pathModule from 'path'; + +const path = pathModule.default; +const getDirName = path.dirname; + +export const writeFileWithDir = (path, contents, cb) => { + mkdir(getDirName(path), { recursive: true }, function (err) { + if (err) return cb(err); + + writeFile(path, contents, cb); + }); +}; diff --git a/src/Umbraco.Web.UI.Client/e2e/installer.spec.ts b/src/Umbraco.Web.UI.Client/e2e/installer.spec.ts new file mode 100644 index 0000000000..623967b104 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/e2e/installer.spec.ts @@ -0,0 +1,95 @@ +const { rest } = window.MockServiceWorker; + +import { umbracoPath } from '@umbraco-cms/backoffice/utils'; +import { + type ProblemDetails, + RuntimeLevelModel, + type ServerStatusResponseModel, +} from '@umbraco-cms/backoffice/external/backend-api'; +import { expect, test } from './test.js'; + +test.describe('installer tests', () => { + test.beforeEach(async ({ page, worker }) => { + await worker.use( + // Override the server status to be "must-install" + rest.get(umbracoPath('/server/status'), (_req, res, ctx) => { + return res( + // Respond with a 200 status code + ctx.status(200), + ctx.json({ + serverStatus: RuntimeLevelModel.INSTALL, + }), + ); + }), + ); + + await page.goto('/install'); + + await page.waitForSelector('[data-test="installer"]'); + }); + + test('installer is shown', async ({ page }) => { + await expect(page).toHaveURL('/install'); + }); + + test.describe('test success and failure', () => { + test.beforeEach(async ({ page }) => { + await page.waitForSelector('[data-test="installer-user"]'); + await page.fill('[aria-label="name"]', 'Test'); + await page.fill('[aria-label="email"]', 'test@umbraco'); + await page.fill('[aria-label="password"]', 'test123456'); + await page.click('[name="subscribeToNewsletter"]'); + + // Go to the next step + await page.click('[aria-label="Next"]'); + + // Set telemetry + await page.waitForSelector('[data-test="installer-telemetry"]'); + await page.waitForSelector('uui-slider[name="telemetryLevel"]'); + + // Click [aria-label="Next"] + await page.click('[aria-label="Next"]'); + + // Database form + await page.waitForSelector('[data-test="installer-database"]'); + }); + + test('installer completes successfully', async ({ page }) => { + await page.click('[aria-label="Install"]'); + await page.waitForSelector('umb-backoffice', { timeout: 30000 }); + }); + + test('installer fails', async ({ page, worker }) => { + await worker.use( + // Override the server status to be "must-install" + rest.post(umbracoPath('/install/setup'), (_req, res, ctx) => { + return res( + // Respond with a 200 status code + ctx.status(400), + ctx.json({ + status: 400, + type: 'validation', + detail: 'Something went wrong', + errors: { + databaseName: ['The database name is required'], + }, + }), + ); + }), + ); + + await page.click('[aria-label="Install"]'); + + await page.waitForSelector('[data-test="installer-error"]'); + + await expect(page.locator('[data-test="error-message"]')).toHaveText('Something went wrong', { + useInnerText: true, + }); + + // Click reset button + await page.click('#button-reset'); + + await page.waitForSelector('[data-test="installer-user"]'); + }); + }); +}); diff --git a/src/Umbraco.Web.UI.Client/e2e/package.json b/src/Umbraco.Web.UI.Client/e2e/package.json new file mode 100644 index 0000000000..959170ed46 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/e2e/package.json @@ -0,0 +1,4 @@ +{ + "name": "backoffice-e2e", + "type": "commonjs" +} diff --git a/src/Umbraco.Web.UI.Client/e2e/test.ts b/src/Umbraco.Web.UI.Client/e2e/test.ts new file mode 100644 index 0000000000..982ff1f44f --- /dev/null +++ b/src/Umbraco.Web.UI.Client/e2e/test.ts @@ -0,0 +1,20 @@ +import { expect, test as base } from '@playwright/test'; +import { createWorkerFixture } from 'playwright-msw'; +import type { MockServiceWorker } from 'playwright-msw'; + +import { handlers } from '../src/mocks/e2e-handlers.js'; + +const test = base.extend<{ + worker: MockServiceWorker; +}>({ + worker: createWorkerFixture(handlers), + page: async ({ page }, use) => { + // Set is-authenticated in sessionStorage to true + await page.addInitScript(`window.sessionStorage.setItem('is-authenticated', 'true');`); + + // Use signed-in page in all tests + await use(page); + }, +}); + +export { test, expect }; diff --git a/src/Umbraco.Web.UI.Client/e2e/upgrader.spec.ts b/src/Umbraco.Web.UI.Client/e2e/upgrader.spec.ts new file mode 100644 index 0000000000..0a2b28ccb5 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/e2e/upgrader.spec.ts @@ -0,0 +1,65 @@ +const { rest } = window.MockServiceWorker; +import { umbracoPath } from '@umbraco-cms/backoffice/utils'; +import { + type ProblemDetails, + RuntimeLevelModel, + type ServerStatusResponseModel, +} from '@umbraco-cms/backoffice/external/backend-api'; +import { expect, test } from './test.js'; + +test.describe('upgrader tests', () => { + test.beforeEach(async ({ page, worker }) => { + await worker.use( + // Override the server status to be "must-install" + rest.get(umbracoPath('/server/status'), (_req, res, ctx) => { + return res( + // Respond with a 200 status code + ctx.status(200), + ctx.json({ + serverStatus: RuntimeLevelModel.UPGRADE, + }), + ); + }), + ); + + await page.goto('/upgrade'); + }); + + test('upgrader is shown', async ({ page }) => { + await page.waitForSelector('[data-test="upgrader"]'); + await expect(page).toHaveURL('/upgrade'); + await expect(page.locator('h1')).toHaveText('Upgrading Umbraco', { useInnerText: true }); + }); + + test('upgrader has a "View Report" button', async ({ page }) => { + await expect(page.locator('[data-test="view-report-button"]')).toBeVisible(); + }); + + test('upgrader completes successfully', async ({ page }) => { + await page.click('[data-test="continue-button"]'); + await page.waitForSelector('umb-backoffice', { timeout: 30000 }); + }); + + test('upgrader fails and shows error', async ({ page, worker }) => { + await worker.use( + // Override the server status to be "must-install" + rest.post(umbracoPath('/upgrade/authorize'), (_req, res, ctx) => { + return res( + // Respond with a 200 status code + ctx.status(400), + ctx.json({ + status: 400, + type: 'error', + detail: 'Something went wrong', + }), + ); + }), + ); + + await page.click('[data-test="continue-button"]'); + + await expect(page.locator('[data-test="error-message"]')).toHaveText('Something went wrong', { + useInnerText: true, + }); + }); +}); diff --git a/src/Umbraco.Web.UI.Client/eslint-local-rules.cjs b/src/Umbraco.Web.UI.Client/eslint-local-rules.cjs new file mode 100644 index 0000000000..ed3c3364ff --- /dev/null +++ b/src/Umbraco.Web.UI.Client/eslint-local-rules.cjs @@ -0,0 +1,27 @@ +'use strict'; + +const badTypeImportRule = require('./devops/eslint/rules/bad-type-import.cjs'); +const enforceElementSuffixOnElementClassNameRule = require('./devops/eslint/rules/enforce-element-suffix-on-element-class-name.cjs'); +const enforceUmbPrefixOnElementNameRule = require('./devops/eslint/rules/enforce-umb-prefix-on-element-name.cjs'); +const enforceUmbracoExternalImportsRule = require('./devops/eslint/rules/enforce-umbraco-external-imports.cjs'); +const ensureRelativeImportUseJsExtensionRule = require('./devops/eslint/rules/ensure-relative-import-use-js-extension.cjs'); +const exportedStringConstantNaming = require('./devops/eslint/rules/exported-string-constant-naming.cjs'); +const noDirectApiImportRule = require('./devops/eslint/rules/no-direct-api-import.cjs'); +const preferImportAliasesRule = require('./devops/eslint/rules/prefer-import-aliases.cjs'); +const preferStaticStylesLastRule = require('./devops/eslint/rules/prefer-static-styles-last.cjs'); +const umbClassPrefixRule = require('./devops/eslint/rules/umb-class-prefix.cjs'); +const noRelativeImportToImportMapModule = require('./devops/eslint/rules/no-relative-import-to-import-map-module.cjs'); + +module.exports = { + 'bad-type-import': badTypeImportRule, + 'enforce-element-suffix-on-element-class-name': enforceElementSuffixOnElementClassNameRule, + 'enforce-umb-prefix-on-element-name': enforceUmbPrefixOnElementNameRule, + 'enforce-umbraco-external-imports': enforceUmbracoExternalImportsRule, + 'ensure-relative-import-use-js-extension': ensureRelativeImportUseJsExtensionRule, + 'exported-string-constant-naming': exportedStringConstantNaming, + 'no-direct-api-import': noDirectApiImportRule, + 'prefer-import-aliases': preferImportAliasesRule, + 'prefer-static-styles-last': preferStaticStylesLastRule, + 'umb-class-prefix': umbClassPrefixRule, + 'no-relative-import-to-import-map-module': noRelativeImportToImportMapModule, +}; diff --git a/src/Umbraco.Web.UI.Client/eslint.config.js b/src/Umbraco.Web.UI.Client/eslint.config.js new file mode 100644 index 0000000000..d5c5d55530 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/eslint.config.js @@ -0,0 +1,94 @@ +import js from '@eslint/js'; +import globals from 'globals'; +import importPlugin from 'eslint-plugin-import'; +import localRules from 'eslint-plugin-local-rules'; +import wcPlugin from 'eslint-plugin-wc'; +import litPlugin from 'eslint-plugin-lit'; +import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended'; +import tseslint from 'typescript-eslint'; +import jsdoc from 'eslint-plugin-jsdoc'; + +export default [ + // Recommended config applied to all files + js.configs.recommended, + ...tseslint.configs.recommended, + wcPlugin.configs['flat/recommended'], + litPlugin.configs['flat/recommended'], + jsdoc.configs['flat/recommended'], // We use the non typescript version to allow types to be defined in the jsdoc comments. This will allow js docs as an alternative to typescript types. + localRules.configs.all, + eslintPluginPrettierRecommended, + + // Global ignores + { + ignores: [ + '**/eslint.config.js', + '**/rollup.config.js', + '**/vite.config.ts', + 'src/external', + 'src/packages/core/icon-registry/icons', + 'src/packages/core/icon-registry/icons.ts', + 'src/**/*.test.ts', + ], + }, + + // Global config + { + languageOptions: { + parserOptions: { + project: true, + tsconfigRootDir: import.meta.dirname, + }, + globals: { + ...globals.browser, + }, + }, + plugins: { + import: importPlugin, + 'local-rules': localRules, + }, + rules: { + semi: ['warn', 'always'], + 'prettier/prettier': ['warn', { endOfLine: 'auto' }], + 'no-unused-vars': 'off', //Let '@typescript-eslint/no-unused-vars' catch the errors to allow unused function parameters (ex: in interfaces) + 'no-var': 'error', + ...importPlugin.configs.recommended.rules, + 'import/namespace': 'off', + 'import/no-unresolved': 'off', + 'import/order': ['warn', { groups: ['builtin', 'parent', 'sibling', 'index', 'external'] }], + 'import/no-self-import': 'error', + 'import/no-cycle': ['error', { maxDepth: 6, allowUnsafeDynamicCyclicDependency: true }], + 'import/no-named-as-default': 'off', // Does not work with eslint 9 + 'import/no-named-as-default-member': 'off', // Does not work with eslint 9 + 'local-rules/prefer-static-styles-last': 'warn', + 'local-rules/enforce-umbraco-external-imports': [ + 'error', + { + exceptions: ['@umbraco-cms', '@open-wc/testing', '@storybook', 'msw', '.', 'vite'], + }, + ], + 'local-rules/exported-string-constant-naming': [ + 'error', + { + excludedFileNames: ['umbraco-package', 'input-tiny-mce.defaults'], // TODO: what to do about the tiny mce defaults? + }, + ], + '@typescript-eslint/no-non-null-assertion': 'off', + '@typescript-eslint/no-explicit-any': 'warn', + '@typescript-eslint/no-unused-vars': 'error', + '@typescript-eslint/consistent-type-exports': 'error', + '@typescript-eslint/consistent-type-imports': 'error', + '@typescript-eslint/no-import-type-side-effects': 'warn', + }, + }, + + // Pattern-specific overrides + { + files: ['**/*.js'], + ...tseslint.configs.disableTypeChecked, + languageOptions: { + globals: { + ...globals.node, + }, + }, + }, +]; diff --git a/src/Umbraco.Web.UI.Client/examples/README.md b/src/Umbraco.Web.UI.Client/examples/README.md new file mode 100644 index 0000000000..8f6d34050e --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/README.md @@ -0,0 +1,7 @@ +# Backoffice Examples + +This folder contains example packages showcasing the usage of extensions in Backoffice. + +The purpose of these projects includes serving as demonstration or example for +packages, as well as testing to make sure the extension points continue +to work in these situations and to assist in developing new integrations. diff --git a/src/Umbraco.Web.UI.Client/examples/block-custom-view/README.md b/src/Umbraco.Web.UI.Client/examples/block-custom-view/README.md new file mode 100644 index 0000000000..e0894b30b7 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/block-custom-view/README.md @@ -0,0 +1,7 @@ +# Property Dataset Dashboard Example + +This example is a work in progress example of how to write a property editor. + +This example covers a few points: + +- Using an existing Property Editor Schema diff --git a/src/Umbraco.Web.UI.Client/examples/block-custom-view/block-custom-view.ts b/src/Umbraco.Web.UI.Client/examples/block-custom-view/block-custom-view.ts new file mode 100644 index 0000000000..8f0e4a11e7 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/block-custom-view/block-custom-view.ts @@ -0,0 +1,57 @@ +import { UmbTextStyles } from '@umbraco-cms/backoffice/style'; +import { html, customElement, LitElement, property, css } from '@umbraco-cms/backoffice/external/lit'; +import { UmbElementMixin } from '@umbraco-cms/backoffice/element-api'; +import type { UmbBlockDataType } from '@umbraco-cms/backoffice/block'; +import type { UmbBlockEditorCustomViewElement } from '@umbraco-cms/backoffice/block-custom-view'; + +// eslint-disable-next-line local-rules/enforce-umb-prefix-on-element-name +@customElement('example-block-custom-view') +// eslint-disable-next-line local-rules/umb-class-prefix +export class ExampleBlockCustomView extends UmbElementMixin(LitElement) implements UmbBlockEditorCustomViewElement { + // + @property({ attribute: false }) + content?: UmbBlockDataType; + + @property({ attribute: false }) + settings?: UmbBlockDataType; + + override render() { + return html` +
+
My Custom View
+

Headline: ${this.content?.headline}

+

Alignment: ${this.settings?.blockAlignment}

+
+ `; + } + + static override styles = [ + UmbTextStyles, + css` + :host { + display: block; + height: 100%; + box-sizing: border-box; + background-color: red; + color: white; + border-radius: 9px; + padding: 12px; + } + + .align-center { + text-align: center; + } + .align-right { + text-align: right; + } + `, + ]; +} + +export default ExampleBlockCustomView; + +declare global { + interface HTMLElementTagNameMap { + 'example-block-custom-view': ExampleBlockCustomView; + } +} diff --git a/src/Umbraco.Web.UI.Client/examples/block-custom-view/index.ts b/src/Umbraco.Web.UI.Client/examples/block-custom-view/index.ts new file mode 100644 index 0000000000..b015618ffe --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/block-custom-view/index.ts @@ -0,0 +1,10 @@ +export const manifests: Array = [ + { + type: 'blockEditorCustomView', + alias: 'Umb.blockEditorCustomView.TestView', + name: 'Block Editor Custom View Test', + element: () => import('./block-custom-view.js'), + forContentTypeAlias: 'headlineUmbracoDemoBlock', + forBlockEditor: ['block-list', 'block-grid'], + }, +]; diff --git a/src/Umbraco.Web.UI.Client/examples/custom-modal/example-custom-modal-dashboard.element.ts b/src/Umbraco.Web.UI.Client/examples/custom-modal/example-custom-modal-dashboard.element.ts new file mode 100644 index 0000000000..1606e9aab2 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/custom-modal/example-custom-modal-dashboard.element.ts @@ -0,0 +1,46 @@ +import { EXAMPLE_MODAL_TOKEN, type ExampleModalData, type ExampleModalResult } from './example-modal-token.js'; +import { css, html, customElement } from '@umbraco-cms/backoffice/external/lit'; +import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; +import { UMB_MODAL_MANAGER_CONTEXT } from '@umbraco-cms/backoffice/modal'; +import './example-custom-modal-element.element.js'; + +@customElement('example-custom-modal-dashboard') +export class UmbExampleCustomModalDashboardElement extends UmbLitElement { + + #modalManagerContext? : typeof UMB_MODAL_MANAGER_CONTEXT.TYPE; + + constructor() { + super(); + this.consumeContext(UMB_MODAL_MANAGER_CONTEXT,(instance)=>{ + this.#modalManagerContext = instance; + }) + } + + #onOpenModal(){ + this.#modalManagerContext?.open(this,EXAMPLE_MODAL_TOKEN,{}) + } + + override render() { + return html` + +

Open the custom modal

+ Open Modal + + `; + } + + static override styles = [css` + :host{ + display:block; + padding:20px; + } + `]; +} + +export default UmbExampleCustomModalDashboardElement + +declare global { + interface HTMLElementTagNameMap { + 'example-custom-modal-dashboard': UmbExampleCustomModalDashboardElement; + } +} diff --git a/src/Umbraco.Web.UI.Client/examples/custom-modal/example-custom-modal-element.element.ts b/src/Umbraco.Web.UI.Client/examples/custom-modal/example-custom-modal-element.element.ts new file mode 100644 index 0000000000..4892d6af18 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/custom-modal/example-custom-modal-element.element.ts @@ -0,0 +1,50 @@ +import { css, html } from "@umbraco-cms/backoffice/external/lit"; +import { defineElement, UUIModalElement } from "@umbraco-cms/backoffice/external/uui"; + +/** + * This class defines a custom design for the modal it self, in the same was as + * UUIModalSidebarElement and UUIModalDialogElement. + */ +@defineElement('example-modal-element') +export class UmbExampleCustomModalElement extends UUIModalElement { + override render() { + return html` + +

Custom Modal-wrapper

+ + + `; + } + + static override styles = [ + ...UUIModalElement.styles, + css` + dialog { + width:100%; + height:100%; + max-width: 100%; + max-height: 100%; + top:0; + left:0; + right:0; + bottom:0; + background:#fff; + } + :host([index='0']) dialog { + box-shadow: var(--uui-shadow-depth-5); + } + :host(:not([index='0'])) dialog { + outline: 1px solid rgba(0, 0, 0, 0.1); + } + + `, + ]; +} + +export default UmbExampleCustomModalElement; + +declare global { + interface HTMLElementTagNameMap { + 'example-modal-element': UmbExampleCustomModalElement; + } +} diff --git a/src/Umbraco.Web.UI.Client/examples/custom-modal/example-modal-token.ts b/src/Umbraco.Web.UI.Client/examples/custom-modal/example-modal-token.ts new file mode 100644 index 0000000000..84a643f051 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/custom-modal/example-modal-token.ts @@ -0,0 +1,19 @@ +import { UmbModalToken } from "@umbraco-cms/backoffice/modal"; + +export interface ExampleModalData { + unique: string | null; +} + +export interface ExampleModalResult { + text : string; +} + +export const EXAMPLE_MODAL_TOKEN = new UmbModalToken< +ExampleModalData, +ExampleModalResult +>('example.modal.custom.element', { + modal : { + type : 'custom', + element: () => import('./example-custom-modal-element.element.js'), + } +}); diff --git a/src/Umbraco.Web.UI.Client/examples/custom-modal/example-modal-view.element.ts b/src/Umbraco.Web.UI.Client/examples/custom-modal/example-modal-view.element.ts new file mode 100644 index 0000000000..8bca63cd6f --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/custom-modal/example-modal-view.element.ts @@ -0,0 +1,51 @@ +import type { ExampleModalData, ExampleModalResult } from './example-modal-token.js'; +import { css, html, customElement, property } from '@umbraco-cms/backoffice/external/lit'; +import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; +import type { UmbModalContext } from '@umbraco-cms/backoffice/modal'; +import './example-custom-modal-element.element.js'; + +@customElement('example-modal-view') +export class UmbExampleModalViewElement extends UmbLitElement { + + @property({ attribute: false }) + public modalContext?: UmbModalContext; + + onClickDone(){ + this.modalContext?.submit(); + } + + override render() { + return html` + + `; + } + + static override styles = [css` + :host { + background: #eaeaea; + display: block; + box-sizing:border-box; + } + + #modal { + box-sizing:border-box; + } + + p { + margin:0; + padding:0; + } + + `]; +} + +export default UmbExampleModalViewElement + +declare global { + interface HTMLElementTagNameMap { + 'example-modal-view': UmbExampleModalViewElement; + } +} diff --git a/src/Umbraco.Web.UI.Client/examples/custom-modal/index.ts b/src/Umbraco.Web.UI.Client/examples/custom-modal/index.ts new file mode 100644 index 0000000000..2ddf119f38 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/custom-modal/index.ts @@ -0,0 +1,29 @@ +import type { ManifestDashboard } from '@umbraco-cms/backoffice/dashboard'; +import type { ManifestModal } from '@umbraco-cms/backoffice/modal'; + +const demoModal : ManifestModal = { + type: 'modal', + name: 'Example Custom Modal Element', + alias: 'example.modal.custom.element', + js: () => import('./example-modal-view.element.js'), +} + +const demoModalsDashboard : ManifestDashboard = { + type: 'dashboard', + name: 'Example Custom Modal Dashboard', + alias: 'example.dashboard.custom.modal.element', + element: () => import('./example-custom-modal-dashboard.element.js'), + weight: 900, + meta: { + label: 'Custom Modal', + pathname: 'custom-modal', + }, + conditions : [ + { + alias: 'Umb.Condition.SectionAlias', + match: 'Umb.Section.Content' + } + ] +} + +export default [demoModal,demoModalsDashboard]; diff --git a/src/Umbraco.Web.UI.Client/examples/dashboard-with-property-dataset/README.md b/src/Umbraco.Web.UI.Client/examples/dashboard-with-property-dataset/README.md new file mode 100644 index 0000000000..557c5709cc --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/dashboard-with-property-dataset/README.md @@ -0,0 +1,10 @@ +# Property Dataset Dashboard Example + +This example demonstrates the essence of the Property Dataset. + +This dashboard implements such, to display a few selected Property Editors and bind the data back to the Dashboard. + + +## SVG code of Icons + +Make sure to use currentColor for fill or stroke color, as that will make the icon adapt to the font color of where its begin used. diff --git a/src/Umbraco.Web.UI.Client/examples/dashboard-with-property-dataset/dataset-dashboard.ts b/src/Umbraco.Web.UI.Client/examples/dashboard-with-property-dataset/dataset-dashboard.ts new file mode 100644 index 0000000000..20cc50236d --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/dashboard-with-property-dataset/dataset-dashboard.ts @@ -0,0 +1,71 @@ +import { UmbTextStyles } from '@umbraco-cms/backoffice/style'; +import { css, html, customElement, LitElement } from '@umbraco-cms/backoffice/external/lit'; +import { UmbElementMixin } from '@umbraco-cms/backoffice/element-api'; +import { type UmbPropertyValueData, type UmbPropertyDatasetElement } from '@umbraco-cms/backoffice/property'; + +@customElement('example-dataset-dashboard') +export class ExampleDatasetDashboard extends UmbElementMixin(LitElement) { + data: UmbPropertyValueData[] = [ + { + alias: 'textProperty', + value: 'Hello', + }, + ]; + + #onDataChange(e: Event) { + const oldValue = this.data; + this.data = (e.target as UmbPropertyDatasetElement).value; + this.requestUpdate('data', oldValue); + } + + override render() { + return html` + +

Dataset Example

+ + + + + +
Output of dashboard data:
+ ${JSON.stringify(this.data, null, 2)} + + `; + } + + static override styles = [ + UmbTextStyles, + css` + :host { + display: block; + padding: var(--uui-size-layout-1); + } + `, + ]; +} + +export default ExampleDatasetDashboard; + +declare global { + interface HTMLElementTagNameMap { + 'example-dataset-dashboard': ExampleDatasetDashboard; + } +} diff --git a/src/Umbraco.Web.UI.Client/examples/dashboard-with-property-dataset/index.ts b/src/Umbraco.Web.UI.Client/examples/dashboard-with-property-dataset/index.ts new file mode 100644 index 0000000000..aaeecd1570 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/dashboard-with-property-dataset/index.ts @@ -0,0 +1,15 @@ +import type { ManifestDashboard } from '@umbraco-cms/backoffice/dashboard'; + +export const manifests: Array = [ + { + type: 'dashboard', + name: 'Example Dataset Dashboard', + alias: 'example.dashboard.dataset', + element: () => import('./dataset-dashboard.js'), + weight: 900, + meta: { + label: 'Dataset example', + pathname: 'dataset-example', + }, + }, +]; diff --git a/src/Umbraco.Web.UI.Client/examples/entity-content-type-condition/index.ts b/src/Umbraco.Web.UI.Client/examples/entity-content-type-condition/index.ts new file mode 100644 index 0000000000..ac4a90f48a --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/entity-content-type-condition/index.ts @@ -0,0 +1,20 @@ +const workspace: UmbExtensionManifest = { + type: 'workspaceView', + alias: 'Example.WorkspaceView.EntityContentTypeCondition', + name: 'Example Workspace View With Entity Content Type Condition', + element: () => import('./workspace-view.element.js'), + meta: { + icon: 'icon-bus', + label: 'Conditional', + pathname: 'conditional', + }, + conditions: [ + { + alias: 'Umb.Condition.WorkspaceContentTypeAlias', + //match : 'blogPost' + oneOf: ['blogPost', 'mediaType1'], + }, + ], +}; + +export const manifests = [workspace]; diff --git a/src/Umbraco.Web.UI.Client/examples/entity-content-type-condition/workspace-view.element.ts b/src/Umbraco.Web.UI.Client/examples/entity-content-type-condition/workspace-view.element.ts new file mode 100644 index 0000000000..b4390f0f62 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/entity-content-type-condition/workspace-view.element.ts @@ -0,0 +1,19 @@ +import { html, customElement } from '@umbraco-cms/backoffice/external/lit'; +import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; + +@customElement('umb-example-entity-content-type-condition') +export class UmbWorkspaceExampleViewElement extends UmbLitElement { + override render() { + return html`

+ This is a conditional element that is only shown in workspaces based on it's entities content type. +

`; + } +} + +export default UmbWorkspaceExampleViewElement; + +declare global { + interface HTMLElementTagNameMap { + 'umb-example-entity-content-type-condition': UmbWorkspaceExampleViewElement; + } +} diff --git a/src/Umbraco.Web.UI.Client/examples/icons/README.md b/src/Umbraco.Web.UI.Client/examples/icons/README.md new file mode 100644 index 0000000000..42c0147752 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/icons/README.md @@ -0,0 +1,7 @@ +# Icons Example + +This example demonstrates how to registerer your own icons. + +Currently they have to be made as JavaScript files that exports an SVG string. + +Declared as part of a Icon Dictionary in a JavaScript file. diff --git a/src/Umbraco.Web.UI.Client/examples/icons/files/icon-heart.ts b/src/Umbraco.Web.UI.Client/examples/icons/files/icon-heart.ts new file mode 100644 index 0000000000..d8dd6c2be4 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/icons/files/icon-heart.ts @@ -0,0 +1,14 @@ +export default ` + + + +`; diff --git a/src/Umbraco.Web.UI.Client/examples/icons/files/icon-wand.ts b/src/Umbraco.Web.UI.Client/examples/icons/files/icon-wand.ts new file mode 100644 index 0000000000..c9425fbae4 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/icons/files/icon-wand.ts @@ -0,0 +1,19 @@ +export default ` + + + + + + + + +`; diff --git a/src/Umbraco.Web.UI.Client/examples/icons/icons-dashboard.ts b/src/Umbraco.Web.UI.Client/examples/icons/icons-dashboard.ts new file mode 100644 index 0000000000..5307bde407 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/icons/icons-dashboard.ts @@ -0,0 +1,36 @@ +import { UmbTextStyles } from '@umbraco-cms/backoffice/style'; +import { css, html, customElement, LitElement } from '@umbraco-cms/backoffice/external/lit'; +import { UmbElementMixin } from '@umbraco-cms/backoffice/element-api'; + +// eslint-disable-next-line local-rules/enforce-umb-prefix-on-element-name +@customElement('example-icons-dashboard') +// eslint-disable-next-line local-rules/umb-class-prefix +export class ExampleIconsDashboard extends UmbElementMixin(LitElement) { + override render() { + return html` + +

Custom icons:

+ + + + `; + } + + static override styles = [ + UmbTextStyles, + css` + :host { + display: block; + padding: var(--uui-size-layout-1); + } + `, + ]; +} + +export default ExampleIconsDashboard; + +declare global { + interface HTMLElementTagNameMap { + 'example-icons-dashboard': ExampleIconsDashboard; + } +} diff --git a/src/Umbraco.Web.UI.Client/examples/icons/icons-dictionary.ts b/src/Umbraco.Web.UI.Client/examples/icons/icons-dictionary.ts new file mode 100644 index 0000000000..b91cd341ba --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/icons/icons-dictionary.ts @@ -0,0 +1,10 @@ +export default [ + { + name: 'my-icon-wand', + path: () => import('./files/icon-wand.js'), + }, + { + name: 'my-icon-heart', + path: () => import('./files/icon-heart.js'), + }, +]; diff --git a/src/Umbraco.Web.UI.Client/examples/icons/index.ts b/src/Umbraco.Web.UI.Client/examples/icons/index.ts new file mode 100644 index 0000000000..b85f8cb006 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/icons/index.ts @@ -0,0 +1,19 @@ +export const manifests: Array = [ + { + type: 'icons', + name: 'Example Dataset Dashboard', + alias: 'example.dashboard.dataset', + js: () => import('./icons-dictionary.js'), + }, + { + type: 'dashboard', + name: 'Example Icons Dashboard', + alias: 'example.dashboard.icons', + element: () => import('./icons-dashboard.js'), + weight: 900, + meta: { + label: 'Icons example', + pathname: 'icons-example', + }, + }, +]; diff --git a/src/Umbraco.Web.UI.Client/examples/index.js b/src/Umbraco.Web.UI.Client/examples/index.js new file mode 100644 index 0000000000..e69de29bb2 diff --git a/src/Umbraco.Web.UI.Client/examples/manifest-picker/README.md b/src/Umbraco.Web.UI.Client/examples/manifest-picker/README.md new file mode 100644 index 0000000000..73944c495c --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/manifest-picker/README.md @@ -0,0 +1,3 @@ +# Manifest Picker Example + +This example demonstrates the Manifest picker input UI. diff --git a/src/Umbraco.Web.UI.Client/examples/manifest-picker/index.ts b/src/Umbraco.Web.UI.Client/examples/manifest-picker/index.ts new file mode 100644 index 0000000000..6565bdb366 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/manifest-picker/index.ts @@ -0,0 +1,15 @@ +import type { ManifestDashboard } from '@umbraco-cms/backoffice/dashboard'; + +export const manifests: Array = [ + { + type: 'dashboard', + name: 'Example Manifest Picker Dashboard', + alias: 'example.dashboard.manifestPicker', + element: () => import('./manifest-picker-dashboard.js'), + weight: 1000, + meta: { + label: 'Manifest Picker example', + pathname: 'example-manifest-picker', + }, + }, +]; diff --git a/src/Umbraco.Web.UI.Client/examples/manifest-picker/manifest-picker-dashboard.ts b/src/Umbraco.Web.UI.Client/examples/manifest-picker/manifest-picker-dashboard.ts new file mode 100644 index 0000000000..43be6cfdd4 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/examples/manifest-picker/manifest-picker-dashboard.ts @@ -0,0 +1,99 @@ +import { css, html, customElement, state, when, nothing } from '@umbraco-cms/backoffice/external/lit'; +import { umbExtensionsRegistry } from '@umbraco-cms/backoffice/extension-registry'; +import type { UmbInputManifestElement } from '@umbraco-cms/backoffice/components'; +import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; +import { UmbTextStyles } from '@umbraco-cms/backoffice/style'; +import type { UUISelectEvent } from '@umbraco-cms/backoffice/external/uui'; + +// eslint-disable-next-line local-rules/enforce-umb-prefix-on-element-name +@customElement('example-manifest-picker-dashboard') +// eslint-disable-next-line local-rules/enforce-element-suffix-on-element-class-name, local-rules/umb-class-prefix +export class ExampleManifestPickerDashboard extends UmbLitElement { + #options: Array