@genesislcap/web-core 14.213.1 → 14.214.0

package/dist/cjs/decorators/deprecated-attr.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deprecatedAttr = void 0;
+const fast_element_1 = require("@microsoft/fast-element");
+const warningQueue = [];
+const logTimeout = 5000;
+setTimeout(() => {
+    if (warningQueue.length) {
+        console.warn(`${warningQueue.length} attribute deprecation notice(s):\n ${warningQueue.join('\n')}`);
+    }
+}, logTimeout);
+/**
+ * Value converter is an interface from FAST which lets you convert types. An example
+ * of this usage is the number converter when using `mode: number` which converts to and from
+ * the string attribute on the DOM, to the number property on the class.
+ *
+ * Instead of doing a conversion we sit in the middle and if a value is set from the attribute
+ * we know that the deprecatedName is used, hence we queue a deprecation warning. We only emit one warning
+ * per attribute per class, to stop repeat emits on change.
+ *
+ * this function needs to take all the variables in separately to capture them in the closure rather
+ * than pulling them from the `deprecatedConfig` object, as that is modified which causes issues such
+ * as infinite loops
+ */
+const deprecationLogger = (className, deprecatedName, attributeName, converter) => ({
+    hasEmitLog: false,
+    toView(value) {
+        return converter ? converter.toView(value) : value;
+    },
+    fromView(value) {
+        if (value && !this.hasEmitLog) {
+            this.hasEmitLog = true;
+            warningQueue.push(`Deprecation warning: attribute name "${deprecatedName}" on component "${className}" is deprecated. Please use "${attributeName}" instead.`);
+        }
+        return converter ? converter.fromView(value) : value;
+    },
+});
+function deprecatedAttr(configOrTarget, prop) {
+    let config;
+    function decorator($target, $prop) {
+        if (arguments.length > 1) {
+            // Non invocation:
+            // - @attr
+            // Invocation with or w/o opts:
+            // - @attr()
+            // - @attr({...opts})
+            config.property = $prop;
+        }
+        fast_element_1.AttributeConfiguration.locate($target.constructor).push(config);
+        if ('deprecatedName' in config) {
+            const deprecatedConfig = structuredClone(config);
+            deprecatedConfig.converter = deprecationLogger($target.constructor.name, deprecatedConfig.deprecatedName, deprecatedConfig.attribute, deprecatedConfig.converter);
+            deprecatedConfig.attribute = config.deprecatedName.toLowerCase();
+            fast_element_1.AttributeConfiguration.locate($target.constructor).push(deprecatedConfig);
+        }
+    }
+    if (arguments.length > 1) {
+        // Non invocation:
+        // - @attr
+        config = {};
+        decorator(configOrTarget, prop);
+        return;
+    }
+    // Invocation with or w/o opts:
+    // - @attr()
+    // - @attr({...opts})
+    config = configOrTarget === void 0 ? {} : configOrTarget;
+    return decorator;
+}
+exports.deprecatedAttr = deprecatedAttr;

package/dist/cjs/decorators/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./deprecated-attr"), exports);

package/dist/cjs/index.js

@@ -4,3 +4,4 @@ const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./directives"), exports);
 tslib_1.__exportStar(require("./FAST"), exports);
 tslib_1.__exportStar(require("./patterns"), exports);
+tslib_1.__exportStar(require("./decorators"), exports);

package/dist/dts/decorators/deprecated-attr.d.ts

@@ -0,0 +1,22 @@
+import { DecoratorAttributeConfiguration } from '@microsoft/fast-element';
+type ExtendedDecoratorAttributeConfiguration = DecoratorAttributeConfiguration & {
+    deprecatedName?: string;
+};
+/**
+ * ALL FOLLOWING CODE FROM FAST IMPLEMENTATION EXCEPT THE `deprecatedName` HANDLING
+ */
+/**
+ * Decorator: Specifies an HTML attribute.
+ * @param config - The configuration for the attribute.
+ * @public
+ */
+export declare function deprecatedAttr(config?: ExtendedDecoratorAttributeConfiguration): (target: {}, property: string) => void;
+/**
+ * Decorator:  Specifies an HTML attribute.
+ * @param target - The class to define the attribute on.
+ * @param prop - The property name to be associated with the attribute.
+ * @public
+ */
+export declare function deprecatedAttr(target: {}, prop: string): void;
+export {};
+//# sourceMappingURL=deprecated-attr.d.ts.map

package/dist/dts/decorators/deprecated-attr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecated-attr.d.ts","sourceRoot":"","sources":["../../../src/decorators/deprecated-attr.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,+BAA+B,EAEhC,MAAM,yBAAyB,CAAC;AAajC,KAAK,uCAAuC,GAAG,+BAA+B,GAAG;IAC/E,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAsCF;;GAEG;AAEH;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,MAAM,CAAC,EAAE,uCAAuC,GAC/C,CAAC,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;AAE1C;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC"}

package/dist/dts/decorators/index.d.ts

@@ -0,0 +1,2 @@
+export * from './deprecated-attr';
+//# sourceMappingURL=index.d.ts.map

package/dist/dts/decorators/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/decorators/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/dist/dts/index.d.ts

@@ -1,4 +1,5 @@
 export * from './directives';
 export * from './FAST';
 export * from './patterns';
+export * from './decorators';
 //# sourceMappingURL=index.d.ts.map

package/dist/dts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC"}

package/dist/esm/decorators/deprecated-attr.js

@@ -0,0 +1,66 @@
+import { AttributeConfiguration, } from '@microsoft/fast-element';
+const warningQueue = [];
+const logTimeout = 5000;
+setTimeout(() => {
+    if (warningQueue.length) {
+        console.warn(`${warningQueue.length} attribute deprecation notice(s):\n ${warningQueue.join('\n')}`);
+    }
+}, logTimeout);
+/**
+ * Value converter is an interface from FAST which lets you convert types. An example
+ * of this usage is the number converter when using `mode: number` which converts to and from
+ * the string attribute on the DOM, to the number property on the class.
+ *
+ * Instead of doing a conversion we sit in the middle and if a value is set from the attribute
+ * we know that the deprecatedName is used, hence we queue a deprecation warning. We only emit one warning
+ * per attribute per class, to stop repeat emits on change.
+ *
+ * this function needs to take all the variables in separately to capture them in the closure rather
+ * than pulling them from the `deprecatedConfig` object, as that is modified which causes issues such
+ * as infinite loops
+ */
+const deprecationLogger = (className, deprecatedName, attributeName, converter) => ({
+    hasEmitLog: false,
+    toView(value) {
+        return converter ? converter.toView(value) : value;
+    },
+    fromView(value) {
+        if (value && !this.hasEmitLog) {
+            this.hasEmitLog = true;
+            warningQueue.push(`Deprecation warning: attribute name "${deprecatedName}" on component "${className}" is deprecated. Please use "${attributeName}" instead.`);
+        }
+        return converter ? converter.fromView(value) : value;
+    },
+});
+export function deprecatedAttr(configOrTarget, prop) {
+    let config;
+    function decorator($target, $prop) {
+        if (arguments.length > 1) {
+            // Non invocation:
+            // - @attr
+            // Invocation with or w/o opts:
+            // - @attr()
+            // - @attr({...opts})
+            config.property = $prop;
+        }
+        AttributeConfiguration.locate($target.constructor).push(config);
+        if ('deprecatedName' in config) {
+            const deprecatedConfig = structuredClone(config);
+            deprecatedConfig.converter = deprecationLogger($target.constructor.name, deprecatedConfig.deprecatedName, deprecatedConfig.attribute, deprecatedConfig.converter);
+            deprecatedConfig.attribute = config.deprecatedName.toLowerCase();
+            AttributeConfiguration.locate($target.constructor).push(deprecatedConfig);
+        }
+    }
+    if (arguments.length > 1) {
+        // Non invocation:
+        // - @attr
+        config = {};
+        decorator(configOrTarget, prop);
+        return;
+    }
+    // Invocation with or w/o opts:
+    // - @attr()
+    // - @attr({...opts})
+    config = configOrTarget === void 0 ? {} : configOrTarget;
+    return decorator;
+}

package/dist/esm/decorators/index.js

@@ -0,0 +1 @@
+export * from './deprecated-attr';

package/dist/esm/index.js

@@ -1,3 +1,4 @@
 export * from './directives';
 export * from './FAST';
 export * from './patterns';
+export * from './decorators';

package/dist/web-core.api.json

@@ -415,6 +415,113 @@
             "endIndex": 5
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/web-core!deprecatedAttr:function(1)",
+          "docComment": "/**\n * Decorator: Specifies an HTML attribute.\n *\n * @param config - The configuration for the attribute.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function deprecatedAttr(config?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ExtendedDecoratorAttributeConfiguration",
+              "canonicalReference": "@genesislcap/web-core!~ExtendedDecoratorAttributeConfiguration:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "(target: {}, property: string) => void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/decorators/deprecated-attr.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "config",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "deprecatedAttr"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/web-core!deprecatedAttr:function(2)",
+          "docComment": "/**\n * Decorator: Specifies an HTML attribute.\n *\n * @param target - The class to define the attribute on.\n *\n * @param prop - The property name to be associated with the attribute.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function deprecatedAttr(target: "
+            },
+            {
+              "kind": "Content",
+              "text": "{}"
+            },
+            {
+              "kind": "Content",
+              "text": ", prop: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/decorators/deprecated-attr.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 2,
+          "parameters": [
+            {
+              "parameterName": "target",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "prop",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "deprecatedAttr"
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/web-core!EventName:type",

package/dist/web-core.d.ts

@@ -39,6 +39,7 @@ import { customElement } from '@microsoft/fast-element';
 import { dataGridCellTemplate } from '@microsoft/fast-foundation';
 import { dataGridRowTemplate } from '@microsoft/fast-foundation';
 import { dataGridTemplate } from '@microsoft/fast-foundation';
+import { DecoratorAttributeConfiguration } from '@microsoft/fast-element';
 import { defaultExecutionContext } from '@microsoft/fast-element';
 import { DefaultRouteRecognizer } from '@microsoft/fast-router';
 import { DesignSystem } from '@microsoft/fast-foundation';
@@ -280,6 +281,24 @@ export declare type DefineFunction<TType> = (definition: PartialFASTElementDefin
  */
 export declare type DefinitionOverrider = (override: PartialFASTElementDefinition) => PartialFASTElementDefinition;
 
+/**
+ * ALL FOLLOWING CODE FROM FAST IMPLEMENTATION EXCEPT THE `deprecatedName` HANDLING
+ */
+/**
+ * Decorator: Specifies an HTML attribute.
+ * @param config - The configuration for the attribute.
+ * @public
+ */
+export declare function deprecatedAttr(config?: ExtendedDecoratorAttributeConfiguration): (target: {}, property: string) => void;
+
+/**
+ * Decorator:  Specifies an HTML attribute.
+ * @param target - The class to define the attribute on.
+ * @param prop - The property name to be associated with the attribute.
+ * @public
+ */
+export declare function deprecatedAttr(target: {}, prop: string): void;
+
 export { DesignSystem }
 
 export { DesignSystemRegistrationContext }
@@ -316,6 +335,10 @@ export declare type EventName = 'input' | 'change' | 'default';
 
 export { ExecutionContext }
 
+declare type ExtendedDecoratorAttributeConfiguration = DecoratorAttributeConfiguration & {
+    deprecatedName?: string;
+};
+
 export { FASTElement }
 export { FASTElement as GenesisElement }
 

package/docs/api/web-core.deprecatedattr.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/web-core](./web-core.md) &gt; [deprecatedAttr](./web-core.deprecatedattr.md)
+
+## deprecatedAttr() function
+
+Decorator: Specifies an HTML attribute.
+
+**Signature:**
+
+```typescript
+export declare function deprecatedAttr(config?: ExtendedDecoratorAttributeConfiguration): (target: {}, property: string) => void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  config | ExtendedDecoratorAttributeConfiguration | _(Optional)_ The configuration for the attribute. |
+
+**Returns:**
+
+(target: {}, property: string) =&gt; void
+

package/docs/api/web-core.deprecatedattr_1.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/web-core](./web-core.md) &gt; [deprecatedAttr](./web-core.deprecatedattr_1.md)
+
+## deprecatedAttr() function
+
+Decorator: Specifies an HTML attribute.
+
+**Signature:**
+
+```typescript
+export declare function deprecatedAttr(target: {}, prop: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  target | {} | The class to define the attribute on. |
+|  prop | string | The property name to be associated with the attribute. |
+
+**Returns:**
+
+void
+

package/docs/api/web-core.md

@@ -8,6 +8,8 @@
 
 |  Function | Description |
 |  --- | --- |
+|  [deprecatedAttr(config)](./web-core.deprecatedattr.md) | Decorator: Specifies an HTML attribute. |
+|  [deprecatedAttr(target, prop)](./web-core.deprecatedattr_1.md) | Decorator: Specifies an HTML attribute. |
 |  [sync(binding, conversionType, eventName, keyAttr)](./web-core.sync.md) | Creates a synchronization directive that binds a data source to an HTML element, |
 |  [tagFor(dependency)](./web-core.tagfor.md) | **_(BETA)_** Determines what HTML tag name to use for the dependency. |
 |  [whenElse(binding, trueTemplateOrTemplateBinding, falseTemplateOrTemplateBinding)](./web-core.whenelse.md) | Directive that allows supplying an "else" template to the traditional [https://www.fast.design/docs/api/fast-element.when/\#when-function](https://www.fast.design/docs/api/fast-element.when/#when-function) directive |

package/docs/api-report.md

@@ -45,6 +45,7 @@ import { customElement } from '@microsoft/fast-element';
 import { dataGridCellTemplate } from '@microsoft/fast-foundation';
 import { dataGridRowTemplate } from '@microsoft/fast-foundation';
 import { dataGridTemplate } from '@microsoft/fast-foundation';
+import { DecoratorAttributeConfiguration } from '@microsoft/fast-element';
 import { defaultExecutionContext } from '@microsoft/fast-element';
 import { DefaultRouteRecognizer } from '@microsoft/fast-router';
 import { DesignSystem } from '@microsoft/fast-foundation';
@@ -249,6 +250,14 @@ export type DefineFunction<TType> = (definition: PartialFASTElementDefinition) =
 // @beta (undocumented)
 export type DefinitionOverrider = (override: PartialFASTElementDefinition) => PartialFASTElementDefinition;
 
+// Warning: (ae-forgotten-export) The symbol "ExtendedDecoratorAttributeConfiguration" needs to be exported by the entry point index.d.ts
+//
+// @public
+export function deprecatedAttr(config?: ExtendedDecoratorAttributeConfiguration): (target: {}, property: string) => void;
+
+// @public
+export function deprecatedAttr(target: {}, prop: string): void;
+
 export { DesignSystem }
 
 export { DesignSystemRegistrationContext }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/web-core",
   "description": "Genesis Foundation Web Core",
-  "version": "14.213.1",
+  "version": "14.214.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -43,5 +43,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "97adf0941ef3506927d10118aab06e973437baad"
+  "gitHead": "12de0640c63d111cb448bd3204a9d2133afb9c49"
 }