fix(ui-web): deprecate ui-web package in favor of new html-tag pa…

…ckage
orchestratora · Jan 12, 2022 · 0b171f7 · 0b171f7
1 parent 8843f90
commit 0b171f7
Show file tree

Hide file tree

Showing 19 changed files with 96 additions and 7 deletions.
diff --git a/libs/ui-web/README.md b/libs/ui-web/README.md
@@ -4,6 +4,11 @@
 
 ![@orchestrator/ui-web](https://img.shields.io/npm/v/@orchestrator/ui-web)
 
+**DEPRECATED!**
+
+> Please use [`@orchestrator/html-tag`](/libs/html-tag) package instead
+> which has more streamlined API and allows to render any HTML tags available in the Web.
+
 ## Registration
 
 ```ts

diff --git a/libs/ui-web/src/lib/components/ui-web-button-host/ui-web-button-config.ts b/libs/ui-web/src/lib/components/ui-web-button-host/ui-web-button-config.ts
@@ -1,6 +1,9 @@
 import { Injectable } from '@angular/core';
 import { Option, OptionInteger, OptionRequired } from '@orchestrator/core';
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 @Injectable()
 export class UiWebButtonConfig {
   @OptionRequired()

diff --git a/libs/ui-web/src/lib/components/ui-web-button-host/ui-web-button-host.component.ts b/libs/ui-web/src/lib/components/ui-web-button-host/ui-web-button-host.component.ts
@@ -6,6 +6,10 @@ import {
 
 import { UiWebButtonConfig } from './ui-web-button-config';
 
+/**
+ * @deprecated Use `orc-html-tag` component
+ * from `@orchestrator/html-tag` package instead.
+ */
 @Component({
   selector: 'orc-ui-web-button-host',
   templateUrl: './ui-web-button-host.component.html',
@@ -14,6 +18,7 @@ import { UiWebButtonConfig } from './ui-web-button-config';
 })
 @DynamicComponent({ config: UiWebButtonConfig })
 export class UiWebButtonHostComponent
-  implements OrchestratorDynamicComponent<UiWebButtonConfig> {
+  implements OrchestratorDynamicComponent<UiWebButtonConfig>
+{
   @Input() config: UiWebButtonConfig;
 }
diff --git a/libs/ui-web/src/lib/components/ui-web-heading-host/ui-web-heading-config.ts b/libs/ui-web/src/lib/components/ui-web-heading-host/ui-web-heading-config.ts
@@ -1,6 +1,9 @@
 import { Injectable } from '@angular/core';
 import { OptionRange, OptionRequired } from '@orchestrator/core';
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 export enum UiWebHeadingLevel {
   One = 1,
   Two,
@@ -10,6 +13,9 @@ export enum UiWebHeadingLevel {
   Six,
 }
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 @Injectable()
 export class UiWebHeadingConfig {
   @OptionRequired()

diff --git a/libs/ui-web/src/lib/components/ui-web-heading-host/ui-web-heading-host.component.ts b/libs/ui-web/src/lib/components/ui-web-heading-host/ui-web-heading-host.component.ts
@@ -6,6 +6,10 @@ import {
 
 import { UiWebHeadingConfig, UiWebHeadingLevel } from './ui-web-heading-config';
 
+/**
+ * @deprecated Use `orc-html-tag` component
+ * from `@orchestrator/html-tag` package instead.
+ */
 @Component({
   selector: 'orc-ui-web-heading-host',
   templateUrl: './ui-web-heading-host.component.html',
@@ -14,7 +18,8 @@ import { UiWebHeadingConfig, UiWebHeadingLevel } from './ui-web-heading-config';
 })
 @DynamicComponent({ config: UiWebHeadingConfig })
 export class UiWebHeadingHostComponent
-  implements OrchestratorDynamicComponent<UiWebHeadingConfig> {
+  implements OrchestratorDynamicComponent<UiWebHeadingConfig>
+{
   @Input() config: UiWebHeadingConfig;
 
   level = UiWebHeadingLevel;

diff --git a/libs/ui-web/src/lib/components/ui-web-image-host/ui-web-image-config.ts b/libs/ui-web/src/lib/components/ui-web-image-host/ui-web-image-config.ts
@@ -5,6 +5,9 @@ import {
   Option,
 } from '@orchestrator/core';
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 @Injectable()
 export class UiWebImageConfig {
   @OptionRequired()

diff --git a/libs/ui-web/src/lib/components/ui-web-image-host/ui-web-image-host.component.ts b/libs/ui-web/src/lib/components/ui-web-image-host/ui-web-image-host.component.ts
@@ -6,6 +6,10 @@ import {
 
 import { UiWebImageConfig } from './ui-web-image-config';
 
+/**
+ * @deprecated Use `orc-html-tag` component
+ * from `@orchestrator/html-tag` package instead.
+ */
 @Component({
   selector: 'orc-ui-web-image-host',
   templateUrl: './ui-web-image-host.component.html',
@@ -14,7 +18,8 @@ import { UiWebImageConfig } from './ui-web-image-config';
 })
 @DynamicComponent({ config: UiWebImageConfig })
 export class UiWebImageHostComponent
-  implements OrchestratorDynamicComponent<UiWebImageConfig> {
+  implements OrchestratorDynamicComponent<UiWebImageConfig>
+{
   @Input() config: UiWebImageConfig;
 
   get width() {

diff --git a/libs/ui-web/src/lib/components/ui-web-input-host/ui-web-input-config.ts b/libs/ui-web/src/lib/components/ui-web-input-host/ui-web-input-config.ts
@@ -3,6 +3,9 @@ import { Option } from '@orchestrator/core';
 
 import { FormAttributesConfig } from '../../form-attributes-config';
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 @Injectable()
 export class UiWebInputConfig extends FormAttributesConfig {
   @Option()

diff --git a/libs/ui-web/src/lib/components/ui-web-input-host/ui-web-input-host.component.ts b/libs/ui-web/src/lib/components/ui-web-input-host/ui-web-input-host.component.ts
@@ -6,6 +6,10 @@ import {
 
 import { UiWebInputConfig } from './ui-web-input-config';
 
+/**
+ * @deprecated Use `orc-html-tag` component
+ * from `@orchestrator/html-tag` package instead.
+ */
 @Component({
   selector: 'orc-ui-web-input-host',
   templateUrl: './ui-web-input-host.component.html',
@@ -14,6 +18,7 @@ import { UiWebInputConfig } from './ui-web-input-config';
 })
 @DynamicComponent({ config: UiWebInputConfig })
 export class UiWebInputHostComponent
-  implements OrchestratorDynamicComponent<UiWebInputConfig> {
+  implements OrchestratorDynamicComponent<UiWebInputConfig>
+{
   @Input() config: UiWebInputConfig;
 }
diff --git a/libs/ui-web/src/lib/components/ui-web-select-host/ui-web-select-config.ts b/libs/ui-web/src/lib/components/ui-web-select-host/ui-web-select-config.ts
@@ -18,6 +18,9 @@ export function uiWebSelectOptionFactory() {
   );
 }
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 @Injectable()
 export class UiWebSelectConfig extends FormAttributesConfig {
   @OptionTypeFactory(uiWebSelectOptionFactory)

diff --git a/libs/ui-web/src/lib/components/ui-web-select-host/ui-web-select-host.component.ts b/libs/ui-web/src/lib/components/ui-web-select-host/ui-web-select-host.component.ts
@@ -6,6 +6,10 @@ import {
 
 import { UiWebSelectConfig } from './ui-web-select-config';
 
+/**
+ * @deprecated Use `orc-html-tag` component
+ * from `@orchestrator/html-tag` package instead.
+ */
 @Component({
   selector: 'orc-ui-web-select-host',
   templateUrl: './ui-web-select-host.component.html',
@@ -14,6 +18,7 @@ import { UiWebSelectConfig } from './ui-web-select-config';
 })
 @DynamicComponent({ config: UiWebSelectConfig })
 export class UiWebSelectHostComponent
-  implements OrchestratorDynamicComponent<UiWebSelectConfig> {
+  implements OrchestratorDynamicComponent<UiWebSelectConfig>
+{
   @Input() config: UiWebSelectConfig;
 }
diff --git a/libs/ui-web/src/lib/components/ui-web-select/types.ts b/libs/ui-web/src/lib/components/ui-web-select/types.ts
@@ -7,6 +7,9 @@ import {
 } from '@orchestrator/core';
 import { array, string, union } from 'io-ts';
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 export class UiWebSelectOptionPair {
   @OptionRequired()
   label: string;
@@ -24,6 +27,9 @@ export class UiWebSelectOptionPair {
   children?: null | undefined;
 }
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 export const UiWebSelectOptionPairType = classToType(UiWebSelectOptionPair);
 
 /**
@@ -33,6 +39,9 @@ export function uiWebSelectOptionGroupFactory() {
   return array(union([string, UiWebSelectOptionPairType]));
 }
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 export class UiWebSelectOptionGroup {
   @OptionRequired()
   @OptionTypeFactory(uiWebSelectOptionGroupFactory)
@@ -45,8 +54,14 @@ export class UiWebSelectOptionGroup {
   disabled?: boolean;
 }
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 export const UiWebSelectOptionGroupType = classToType(UiWebSelectOptionGroup);
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 export type UiWebSelectOption =
   | string
   | UiWebSelectOptionPair

diff --git a/libs/ui-web/src/lib/components/ui-web-select/ui-web-select.component.ts b/libs/ui-web/src/lib/components/ui-web-select/ui-web-select.component.ts
@@ -6,6 +6,10 @@ import {
   UiWebSelectOptionPair,
 } from './types';
 
+/**
+ * @deprecated Use `orc-html-tag` component
+ * from `@orchestrator/html-tag` package instead.
+ */
 @Component({
   selector: 'orc-ui-web-select',
   templateUrl: './ui-web-select.component.html',

diff --git a/libs/ui-web/src/lib/components/ui-web-text-host/ui-web-text-config.ts b/libs/ui-web/src/lib/components/ui-web-text-host/ui-web-text-config.ts
@@ -3,6 +3,9 @@ import { FunctionWithArg, Option, OptionFunction } from '@orchestrator/core';
 
 export type UiWebTextFn<C> = FunctionWithArg<C, string>;
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 @Injectable()
 export class UiWebTextConfig<C = any> {
   @Option()

diff --git a/libs/ui-web/src/lib/components/ui-web-text-host/ui-web-text-host.component.ts b/libs/ui-web/src/lib/components/ui-web-text-host/ui-web-text-host.component.ts
@@ -13,6 +13,10 @@ import {
 
 import { UiWebTextConfig, UiWebTextFn } from './ui-web-text-config';
 
+/**
+ * @deprecated Use `orc-html-text` component
+ * from `@orchestrator/html-tag` package instead.
+ */
 @Component({
   selector: 'orc-ui-web-text-host',
   templateUrl: './ui-web-text-host.component.html',
@@ -21,7 +25,8 @@ import { UiWebTextConfig, UiWebTextFn } from './ui-web-text-config';
 })
 @DynamicComponent({ config: UiWebTextConfig })
 export class UiWebTextHostComponent
-  implements OrchestratorDynamicComponent<UiWebTextConfig>, OnInit, OnChanges {
+  implements OrchestratorDynamicComponent<UiWebTextConfig>, OnInit, OnChanges
+{
   @Input() config: UiWebTextConfig;
   @Input() context: any;
 

diff --git a/libs/ui-web/src/lib/components/ui-web-textarea-host/ui-web-textarea-config.ts b/libs/ui-web/src/lib/components/ui-web-textarea-host/ui-web-textarea-config.ts
@@ -8,6 +8,9 @@ import {
 
 import { FormAttributesConfig } from '../../form-attributes-config';
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 @Injectable()
 export class UiWebTextAreaConfig extends FormAttributesConfig {
   @Option()

diff --git a/libs/ui-web/src/lib/components/ui-web-textarea-host/ui-web-textarea-host.component.ts b/libs/ui-web/src/lib/components/ui-web-textarea-host/ui-web-textarea-host.component.ts
@@ -6,6 +6,10 @@ import {
 
 import { UiWebTextAreaConfig } from './ui-web-textarea-config';
 
+/**
+ * @deprecated Use `orc-html-tag` component
+ * from `@orchestrator/html-tag` package instead.
+ */
 @Component({
   selector: 'orc-ui-web-textarea-host',
   templateUrl: './ui-web-textarea-host.component.html',
@@ -14,6 +18,7 @@ import { UiWebTextAreaConfig } from './ui-web-textarea-config';
 })
 @DynamicComponent({ config: UiWebTextAreaConfig })
 export class UiWebTextareaHostComponent
-  implements OrchestratorDynamicComponent<UiWebTextAreaConfig> {
+  implements OrchestratorDynamicComponent<UiWebTextAreaConfig>
+{
   @Input() config: UiWebTextAreaConfig;
 }
diff --git a/libs/ui-web/src/lib/form-attributes-config.ts b/libs/ui-web/src/lib/form-attributes-config.ts
@@ -1,5 +1,8 @@
 import { Option, OptionInteger } from '@orchestrator/core';
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 export class FormAttributesConfig {
   @Option()
   name?: string;

diff --git a/libs/ui-web/src/lib/ui-web.module.ts b/libs/ui-web/src/lib/ui-web.module.ts
@@ -10,6 +10,9 @@ import {
 } from './components';
 import { UiWebButtonHostModule } from './components/ui-web-button-host';
 
+/**
+ * @deprecated Use `@orchestrator/html-tag` package instead.
+ */
 @NgModule({
   exports: [
     UiWebButtonHostModule,