docs: Add @since tags to new APIs for v1.1.0

packages/core/src/common/types/common-types.ts

@@ -194,6 +194,7 @@ export interface Middleware {
      * `body-parser` middleware which is automatically applied by NestJS. This can be useful in certain cases such as when you need to access the
      * raw unparsed request for a specific route.
      *
+     * @since 1.1.0
      * @default false
      */
     beforeListen?: boolean;

packages/core/src/config/order/order-by-code-access-strategy.ts

@@ -24,6 +24,7 @@ import { Order } from '../../entity/order/order.entity';
  * }
  * ```
  *
+ * @since 1.1.0
  * @docsCategory orders
  * @docsPage OrderByCodeAccessStrategy
  */

packages/core/src/config/vendure-config.ts

@@ -476,9 +476,10 @@ export interface OrderOptions {
      * @description
      * Defines the strategy used to check if and how an Order may be retrieved via the orderByCode query.
      *
-     * The default strategy permitts permanent access to the Customer owning the Order and anyone
+     * The default strategy permits permanent access to the Customer owning the Order and anyone
      * within 2 hours after placing the Order.
      *
+     * @since 1.1.0
      * @default DefaultOrderByCodeAccessStrategy
      */
     orderByCodeAccessStrategy?: OrderByCodeAccessStrategy;

packages/core/src/event-bus/events/stock-movement-event.ts

@@ -9,6 +9,7 @@ import { VendureEvent } from '../vendure-event';
  * This event is fired whenever a {@link StockMovement} entity is created, which occurs when the saleable
  * stock level of a ProductVariant is altered due to things like sales, manual adjustments, and cancellations.
  *
+ * @since 1.1.0
  * @docsCategory events
  * @docsPage Event Types
  */

packages/core/src/service/transaction/transactional-connection.ts

@@ -38,6 +38,7 @@ export interface GetEntityOrThrowOptions<T = any> extends FindOneOptions<T> {
      * creation of new Entities which may on first attempt be inaccessible due to an ongoing
      * transaction.
      *
+     * @since 1.1.0
      * @default 0
      */
     retries?: number;
@@ -45,6 +46,7 @@ export interface GetEntityOrThrowOptions<T = any> extends FindOneOptions<T> {
      * @description
      * Specifies the delay in ms to wait between retries.
      *
+     * @since 1.1.0
      * @default 25
      */
     retryDelay?: number;

packages/email-plugin/src/event-handler.ts

@@ -137,7 +137,10 @@ export class EmailEventHandler<T extends string = string, Event extends EventWit
     }
 
     /**
+     * @description
      * A function which allows {@link OptionalAddressFields} to be specified such as "cc" and "bcc".
+     *
+     * @since 1.1.0
      */
     setOptionalAddressFields(optionalAddressFieldsFn: SetOptionalAddressFieldsFn<Event>) {
         this.setOptionalAddressFieldsFn = optionalAddressFieldsFn;

packages/email-plugin/src/types.ts

@@ -458,6 +458,7 @@ export type SetAttachmentsFn<Event> = (event: Event) => EmailAttachment[] | Prom
  * @description
  * Optional address-related fields for sending the email.
  *
+ * @since 1.1.0
  * @docsCategory EmailPlugin
  * @docsPage Email Plugin Types
  */
@@ -483,6 +484,7 @@ export interface OptionalAddressFields {
  * @description
  * A function used to set the {@link OptionalAddressFields}.
  *
+ * @since 1.1.0
  * @docsCategory EmailPlugin
  * @docsPage Email Plugin Types
  */