@typescript-deploys/pr-build 5.0.0-pr-52280-2 → 5.0.0-pr-52317-9

package/lib/lib.decorators.d.ts

@@ -0,0 +1,357 @@
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at http://www.apache.org/licenses/LICENSE-2.0
+
+THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
+WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
+MERCHANTABLITY OR NON-INFRINGEMENT.
+
+See the Apache Version 2.0 License for specific language governing permissions
+and limitations under the License.
+***************************************************************************** */
+
+
+
+/// <reference no-default-lib="true"/>
+
+
+/**
+ * The decorator context types provided to class member decorators.
+ */
+type ClassMemberDecoratorContext =
+    | ClassMethodDecoratorContext
+    | ClassGetterDecoratorContext
+    | ClassSetterDecoratorContext
+    | ClassFieldDecoratorContext
+    | ClassAccessorDecoratorContext
+    ;
+
+/**
+ * The decorator context types provided to any decorator.
+ */
+type DecoratorContext =
+    | ClassDecoratorContext
+    | ClassMemberDecoratorContext
+    ;
+
+/**
+ * Context provided to a class decorator.
+ * @template Class The type of the decorated class associated with this context.
+ */
+interface ClassDecoratorContext<
+    Class extends abstract new (...args: any) => any = abstract new (...args: any) => any,
+> {
+    /** The kind of element that was decorated. */
+    readonly kind: "class";
+
+    /** The name of the decorated class. */
+    readonly name: string | undefined;
+
+    /**
+     * Adds a callback to be invoked after the class definition has been finalized.
+     *
+     * @example
+     * ```ts
+     * function customElement(name: string): ClassDecoratorFunction {
+     *   return (target, context) => {
+     *     context.addInitializer(function () {
+     *       customElements.define(name, this);
+     *     });
+     *   }
+     * }
+     *
+     * @customElement("my-element")
+     * class MyElement {}
+     * ```
+     */
+    addInitializer(initializer: (this: Class) => void): void;
+}
+
+/**
+ * Context provided to a class method decorator.
+ * @template This The type on which the class element will be defined. For a static class element, this will be
+ * the type of the constructor. For a non-static class element, this will be the type of the instance.
+ * @template Value The type of the decorated class method.
+ */
+interface ClassMethodDecoratorContext<
+    This = unknown,
+    Value extends (this: This, ...args: any) => any = (this: This, ...args: any) => any,
+> {
+    /** The kind of class member that was decorated. */
+    readonly kind: "method";
+
+    /** The name of the decorated class member. */
+    readonly name: string | symbol;
+
+    /** A value indicating whether the class member is a static (`true`) or instance (`false`) member. */
+    readonly static: boolean;
+
+    /** A value indicating whether the class member has a private name. */
+    readonly private: boolean;
+
+    // NOTE: Disabled, pending the outcome of https://github.com/tc39/proposal-decorators/issues/494
+    // /** An object that can be used to access the current value of the class member at runtime. */
+    // readonly access: {
+    //     /**
+    //      * Gets the current value of the method from the provided receiver.
+    //      *
+    //      * @example
+    //      * let fn = context.access.get.call(instance);
+    //      */
+    //     get(this: This): Value;
+    // };
+
+    /**
+     * Adds a callback to be invoked either before static initializers are run (when
+     * decorating a `static` member), or before instance initializers are run (when
+     * decorating a non-`static` member).
+     *
+     * @example
+     * ```ts
+     * const bound: ClassMethodDecoratorFunction = (value, context) {
+     *   if (context.private) throw new TypeError("Not supported on private methods.");
+     *   context.addInitializer(function () {
+     *     this[context.name] = this[context.name].bind(this);
+     *   });
+     * }
+     *
+     * class C {
+     *   message = "Hello";
+     *
+     *   @bound
+     *   m() {
+     *     console.log(this.message);
+     *   }
+     * }
+     * ```
+     */
+    addInitializer(initializer: (this: This) => void): void;
+}
+
+/**
+ * Context provided to a class getter decorator.
+ * @template This The type on which the class element will be defined. For a static class element, this will be
+ * the type of the constructor. For a non-static class element, this will be the type of the instance.
+ * @template Value The property type of the decorated class getter.
+ */
+interface ClassGetterDecoratorContext<
+    This = unknown,
+    Value = unknown,
+> {
+    /** The kind of class member that was decorated. */
+    readonly kind: "getter";
+
+    /** The name of the decorated class member. */
+    readonly name: string | symbol;
+
+    /** A value indicating whether the class member is a static (`true`) or instance (`false`) member. */
+    readonly static: boolean;
+
+    /** A value indicating whether the class member has a private name. */
+    readonly private: boolean;
+
+    // NOTE: Disabled, pending the outcome of https://github.com/tc39/proposal-decorators/issues/494
+    // /** An object that can be used to access the current value of the class member at runtime. */
+    // readonly access: {
+    //     /**
+    //      * Invokes the getter on the provided receiver.
+    //      *
+    //      * @example
+    //      * let value = context.access.get.call(instance);
+    //      */
+    //     get(this: This): Value;
+    // };
+
+    /**
+     * Adds a callback to be invoked either before static initializers are run (when
+     * decorating a `static` member), or before instance initializers are run (when
+     * decorating a non-`static` member).
+     */
+    addInitializer(initializer: (this: This) => void): void;
+}
+
+/**
+ * Context provided to a class setter decorator.
+ * @template This The type on which the class element will be defined. For a static class element, this will be
+ * the type of the constructor. For a non-static class element, this will be the type of the instance.
+ * @template Value The type of the decorated class setter.
+ */
+interface ClassSetterDecoratorContext<
+    This = unknown,
+    Value = unknown,
+> {
+    /** The kind of class member that was decorated. */
+    readonly kind: "setter";
+
+    /** The name of the decorated class member. */
+    readonly name: string | symbol;
+
+    /** A value indicating whether the class member is a static (`true`) or instance (`false`) member. */
+    readonly static: boolean;
+
+    /** A value indicating whether the class member has a private name. */
+    readonly private: boolean;
+
+    // NOTE: Disabled, pending the outcome of https://github.com/tc39/proposal-decorators/issues/494
+    /** An object that can be used to access the current value of the class member at runtime. */
+    // readonly access: {
+    //     /**
+    //      * Invokes the setter on the provided receiver.
+    //      *
+    //      * @example
+    //      * context.access.set.call(instance, value);
+    //      */
+    //     set(this: This, value: Value): void;
+    // };
+
+    /**
+     * Adds a callback to be invoked either before static initializers are run (when
+     * decorating a `static` member), or before instance initializers are run (when
+     * decorating a non-`static` member).
+     */
+    addInitializer(initializer: (this: This) => void): void;
+}
+
+/**
+ * Context provided to a class `accessor` field decorator.
+ * @template This The type on which the class element will be defined. For a static class element, this will be
+ * the type of the constructor. For a non-static class element, this will be the type of the instance.
+ * @template Value The type of decorated class field.
+ */
+interface ClassAccessorDecoratorContext<
+    This = unknown,
+    Value = unknown,
+> {
+    /** The kind of class member that was decorated. */
+    readonly kind: "accessor";
+
+    /** The name of the decorated class member. */
+    readonly name: string | symbol;
+
+    /** A value indicating whether the class member is a static (`true`) or instance (`false`) member. */
+    readonly static: boolean;
+
+    /** A value indicating whether the class member has a private name. */
+    readonly private: boolean;
+
+    // NOTE: Disabled, pending the outcome of https://github.com/tc39/proposal-decorators/issues/494
+    // /** An object that can be used to access the current value of the class member at runtime. */
+    // readonly access: {
+    //     /**
+    //      * Invokes the getter on the provided receiver.
+    //      *
+    //      * @example
+    //      * let value = context.access.get.call(instance);
+    //      */
+    //     get(this: This): Value;
+
+    //     /**
+    //      * Invokes the setter on the provided receiver.
+    //      *
+    //      * @example
+    //      * context.access.set.call(instance, value);
+    //      */
+    //     set(this: This, value: Value): void;
+    // };
+
+    /**
+     * Adds a callback to be invoked either before static initializers are run (when
+     * decorating a `static` member), or before instance initializers are run (when
+     * decorating a non-`static` member).
+     */
+    addInitializer(initializer: (this: This) => void): void;
+}
+
+/**
+ * Describes the target provided to class `accessor` field decorators.
+ * @template This The `this` type to which the target applies.
+ * @template Value The property type for the class `accessor` field.
+ */
+interface ClassAccessorDecoratorTarget<This, Value> {
+    /**
+     * Invokes the getter that was defined prior to decorator application.
+     *
+     * @example
+     * let value = target.get.call(instance);
+     */
+    get(this: This): Value;
+
+    /**
+     * Invokes the setter that was defined prior to decorator application.
+     *
+     * @example
+     * target.set.call(instance, value);
+     */
+    set(this: This, value: Value): void;
+}
+
+/**
+ * Describes the allowed return value from a class `accessor` field decorator.
+ * @template This The `this` type to which the target applies.
+ * @template Value The property type for the class `accessor` field.
+ */
+interface ClassAccessorDecoratorResult<This, Value> {
+    /**
+     * An optional replacement getter function. If not provided, the existing getter function is used instead.
+     */
+    get?(this: This): Value;
+
+    /**
+     * An optional replacement setter function. If not provided, the existing setter function is used instead.
+     */
+    set?(this: This, value: Value): void;
+
+    /**
+     * An optional initializer mutator that is invoked when the underlying field initializer is evaluated.
+     * @param value The incoming initializer value.
+     * @returns The replacement initializer value.
+     */
+    init?(this: This, value: Value): Value;
+}
+
+/**
+ * Context provided to a class field decorator.
+ * @template This The type on which the class element will be defined. For a static class element, this will be
+ * the type of the constructor. For a non-static class element, this will be the type of the instance.
+ * @template Value The type of the decorated class field.
+ */
+interface ClassFieldDecoratorContext<
+    This = unknown,
+    Value = unknown,
+> {
+    /** The kind of class member that was decorated. */
+    readonly kind: "field";
+
+    /** The name of the decorated class member. */
+    readonly name: string | symbol;
+
+    /** A value indicating whether the class member is a static (`true`) or instance (`false`) member. */
+    readonly static: boolean;
+
+    /** A value indicating whether the class member has a private name. */
+    readonly private: boolean;
+
+    // NOTE: Disabled, pending the outcome of https://github.com/tc39/proposal-decorators/issues/494
+    // /** An object that can be used to access the current value of the class member at runtime. */
+    // readonly access: {
+    //     /**
+    //      * Gets the value of the field on the provided receiver.
+    //      */
+    //     get(this: This): Value;
+
+    //     /**
+    //      * Sets the value of the field on the provided receiver.
+    //      */
+    //     set(this: This, value: Value): void;
+    // };
+
+    /**
+     * Adds a callback to be invoked either before static initializers are run (when
+     * decorating a `static` member), or before instance initializers are run (when
+     * decorating a non-`static` member).
+     */
+    addInitializer(initializer: (this: This) => void): void;
+}

package/lib/lib.decorators.legacy.d.ts

@@ -0,0 +1,24 @@
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at http://www.apache.org/licenses/LICENSE-2.0
+
+THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
+WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
+MERCHANTABLITY OR NON-INFRINGEMENT.
+
+See the Apache Version 2.0 License for specific language governing permissions
+and limitations under the License.
+***************************************************************************** */
+
+
+
+/// <reference no-default-lib="true"/>
+
+
+declare type ClassDecorator = <TFunction extends Function>(target: TFunction) => TFunction | void;
+declare type PropertyDecorator = (target: Object, propertyKey: string | symbol) => void;
+declare type MethodDecorator = <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void;
+declare type ParameterDecorator = (target: Object, propertyKey: string | symbol, parameterIndex: number) => void;

package/lib/lib.es5.d.ts

@@ -18,6 +18,9 @@ and limitations under the License.
 /// <reference no-default-lib="true"/>
 
 
+/// <reference lib="decorators" />
+/// <reference lib="decorators.legacy" />
+
 /////////////////////////////
 /// ECMAScript APIs
 /////////////////////////////
@@ -224,13 +227,13 @@ interface ObjectConstructor {
      * Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
      * @param o Object on which to lock the attributes.
      */
-    freeze<T extends {[idx: string]: U | null | undefined | object}, U extends string | bigint | number | boolean | symbol>(o: T): Readonly<T>;
+    freeze<const T extends {[idx: string]: U | null | undefined | object}, U extends string | bigint | number | boolean | symbol>(o: T): Readonly<T>;
 
     /**
      * Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
      * @param o Object on which to lock the attributes.
      */
-    freeze<T>(o: T): Readonly<T>;
+    freeze<const T>(o: T): Readonly<T>;
 
     /**
      * Prevents the addition of new properties to an object.
@@ -1137,13 +1140,6 @@ interface JSON {
      * If a member contains nested objects, the nested objects are transformed before the parent object is.
      */
     parse(text: string, reviver?: (this: any, key: string, value: any) => any): any;
-    /**
-     * Converts a JavaScript value to a JavaScript Object Notation (JSON) string.
-     * @param value A JavaScript value, usually an object or array, to be converted.
-     * @param replacer An array of strings and numbers that acts as an approved list for selecting the object properties that will be stringified.
-     * @param space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
-     */
-    stringify(value: Function | Symbol | undefined, replacer?: (number | string)[] | null, space?: string | number): undefined;
     /**
      * Converts a JavaScript value to a JavaScript Object Notation (JSON) string.
      * @param value A JavaScript value, usually an object or array, to be converted.
@@ -1510,11 +1506,6 @@ interface TypedPropertyDescriptor<T> {
     set?: (value: T) => void;
 }
 
-declare type ClassDecorator = <TFunction extends Function>(target: TFunction) => TFunction | void;
-declare type PropertyDecorator = (target: Object, propertyKey: string | symbol) => void;
-declare type MethodDecorator = <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void;
-declare type ParameterDecorator = (target: Object, propertyKey: string | symbol, parameterIndex: number) => void;
-
 declare type PromiseConstructorLike = new <T>(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void) => PromiseLike<T>;
 
 interface PromiseLike<T> {