@microsoft/decorators 1.22.0-beta.1 → 1.22.0-beta.3

package/lib/decorators.manifest.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-component-manifest.schema.json",
+
+  "id": "f97266fb-ccb7-430e-9384-4124d05295d3",
+  "alias": "Decorators",
+  "componentType": "Library",
+  "version": "*",
+  "manifestVersion": 2
+}

package/lib/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * A conservative set of decorators intended for use in both NodeJS and web browser projects.
+ *
+ * @remarks
+ * This package provides a small set of decorators that enable more rigorous specification
+ * of API contracts when using the TypeScript language.  The intent is to better document
+ * expected behaviors and catch common mistakes.  This package is not intended to be a
+ * general toolkit of language extensions or helpful macros.
+ *
+ * @packagedocumentation
+ */
+export { virtual } from './virtual';
+export { sealed } from './sealed';
+export { override } from './override';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}

package/lib/index.js

@@ -0,0 +1,15 @@
+/**
+ * A conservative set of decorators intended for use in both NodeJS and web browser projects.
+ *
+ * @remarks
+ * This package provides a small set of decorators that enable more rigorous specification
+ * of API contracts when using the TypeScript language.  The intent is to better document
+ * expected behaviors and catch common mistakes.  This package is not intended to be a
+ * general toolkit of language extensions or helpful macros.
+ *
+ * @packagedocumentation
+ */
+export { virtual } from './virtual';
+export { sealed } from './sealed';
+export { override } from './override';
+//# sourceMappingURL=index.js.map

package/lib/override.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This decorator is applied to a class's member function or property.
+ * It indicates that the definition overrides another definition (of the same name)
+ * from the base class.  The base class definition must be marked as \@virtual.
+ * This decorator is currently used for documentation purposes only.
+ * In the future, it may be enforced at runtime.
+ *
+ * @public
+ */
+export declare function override(target: object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<any>): void;
+//# sourceMappingURL=override.d.ts.map

package/lib/override.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"override.d.ts","sourceRoot":"","sources":["../src/override.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,GAAG,MAAM,EAE5B,UAAU,EAAE,uBAAuB,CAAC,GAAG,CAAC,GACvC,IAAI,CAGN"}

package/lib/override.js

@@ -0,0 +1,16 @@
+/**
+ * This decorator is applied to a class's member function or property.
+ * It indicates that the definition overrides another definition (of the same name)
+ * from the base class.  The base class definition must be marked as \@virtual.
+ * This decorator is currently used for documentation purposes only.
+ * In the future, it may be enforced at runtime.
+ *
+ * @public
+ */
+export function override(target, propertyKey, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+descriptor) {
+    // Eventually we may implement runtime validation (e.g. in DEBUG builds)
+    // but currently this decorator is only used by the build tools.
+}
+//# sourceMappingURL=override.js.map

package/lib/sealed.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This decorator is applied to a class (but NOT member function or property).
+ * It indicates that subclasses must not inherit from this class.
+ * This decorator is currently used for documentation purposes only.
+ * In the future, it may be enforced at runtime.
+ *
+ * @public
+ */
+export declare function sealed(target: Function): void;
+//# sourceMappingURL=sealed.d.ts.map

package/lib/sealed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sealed.d.ts","sourceRoot":"","sources":["../src/sealed.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,wBAAgB,MAAM,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAG7C"}

package/lib/sealed.js

@@ -0,0 +1,14 @@
+/**
+ * This decorator is applied to a class (but NOT member function or property).
+ * It indicates that subclasses must not inherit from this class.
+ * This decorator is currently used for documentation purposes only.
+ * In the future, it may be enforced at runtime.
+ *
+ * @public
+ */
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+export function sealed(target) {
+    // Eventually we may implement runtime validation (e.g. in DEBUG builds)
+    // but currently this decorator is only used by the build tools.
+}
+//# sourceMappingURL=sealed.js.map

package/lib/virtual.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This decorator is applied to a class's member function or property.
+ * It indicates that the definition may optionally be overridden in a
+ * child class.  Conversely, if the \@virtual decorator is NOT applied to
+ * a definition, then child classes may NOT override it.
+ * This decorator is currently used for documentation purposes only.
+ * In the future, it may be enforced at runtime.
+ *
+ * @public
+ */
+export declare function virtual(target: object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<any>): void;
+//# sourceMappingURL=virtual.d.ts.map

package/lib/virtual.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"virtual.d.ts","sourceRoot":"","sources":["../src/virtual.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CACrB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,GAAG,MAAM,EAE5B,UAAU,EAAE,uBAAuB,CAAC,GAAG,CAAC,GACvC,IAAI,CAGN"}

package/lib/virtual.js

@@ -0,0 +1,17 @@
+/**
+ * This decorator is applied to a class's member function or property.
+ * It indicates that the definition may optionally be overridden in a
+ * child class.  Conversely, if the \@virtual decorator is NOT applied to
+ * a definition, then child classes may NOT override it.
+ * This decorator is currently used for documentation purposes only.
+ * In the future, it may be enforced at runtime.
+ *
+ * @public
+ */
+export function virtual(target, propertyKey, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+descriptor) {
+    // Eventually we may implement runtime validation (e.g. in DEBUG builds)
+    // but currently this decorator is only used by the build tools.
+}
+//# sourceMappingURL=virtual.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/decorators",
-  "version": "1.22.0-beta.1",
+  "version": "1.22.0-beta.3",
   "description": "A very conservative set of decorators for TypeScript projects",
   "license": "https://aka.ms/spfx/license",
   "homepage": "http://aka.ms/spfx",
@@ -12,7 +12,7 @@
     "tslib": "2.3.1"
   },
   "devDependencies": {
-    "@rushstack/heft": "0.73.6",
+    "@rushstack/heft": "0.74.3",
     "eslint": "8.57.1",
     "@msinternal/spfx-internal-web-build-rig": "0.1.0"
   },