@sass/types 1.106.1 → 1.107.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sass/types",
-  "version": "1.106.1",
+  "version": "1.107.0",
   "description": "A standalone types package for the Sass JS API",
   "repository": "sass/dart-sass",
   "author": "Google Inc.",

package/types/deprecations.d.ts

@@ -3,10 +3,12 @@
  *
  * Any of these IDs or the deprecation objects they point to can be passed to
  * `fatalDeprecations`, `futureDeprecations`, or `silenceDeprecations`.
+ *
+ * @category Messages
  */
 export interface Deprecations {
   // START AUTOGENERATED LIST
-  // Checksum: 1e05e728d95255e2e9fadbe9696baf751fc7ef66
+  // Checksum: 2c5800a683ec3b36c9e8d7f6eb427466b7439461
 
   /**
    * Deprecation for passing a string directly to meta.call().
@@ -214,6 +216,13 @@ export interface Deprecations {
    */
   'adjacent-compounds': Deprecation<'adjacent-compounds'>;
 
+  /**
+   * Deprecation for selecting versions beyond the current one for `fatalDeprecations`.
+   *
+   * This deprecation became active in Dart Sass 1.107.0.
+   */
+  'deprecation-version': Deprecation<'deprecation-version'>;
+
   // END AUTOGENERATED LIST
 
   /**
@@ -222,6 +231,26 @@ export interface Deprecations {
   'user-authored': Deprecation<'user-authored', 'user'>;
 }
 
+/**
+ * A value that selects a set of {@link Deprecation}s.
+ *
+ * * {@link DeprecationOrId} selects a single deprecation.
+ * * `Version` selects all deprecations that were present in that version of the
+ *   current Sass implementation. The version must be less than or equal to the
+ *   version of the library being used.
+ * * `DeprecationSelector[]` selects all deprecations selected by any of the
+ *   listed selectors.
+ * * {@link DeprecationSelectorDifference} selects all deprecations matched by a
+ *   `DeprecationSelector` *other than* a list of specific deprecations.
+ *
+ * @category Messages
+ */
+export type DeprecationSelector =
+  | DeprecationOrId
+  | Version
+  | DeprecationSelectorDifference
+  | DeprecationSelector[];
+
 /**
  * Either a deprecation or its ID, either of which can be passed to any of
  * the relevant compiler options.
@@ -231,12 +260,32 @@ export interface Deprecations {
  */
 export type DeprecationOrId = Deprecation | keyof Deprecations;
 
+/**
+ * An object that selects all deprecations selected by a
+ * {@link DeprecationSelector} other than a specific list of excluded
+ * deprecations.
+ *
+ * @category Messages
+ * @compatibility dart: "1.106.0", node: false
+ */
+export interface DeprecationSelectorDifference {
+  /** The selected deprecations this, unless excluded by {@link exclude}. */
+  include: DeprecationSelector;
+
+  /**
+   * Deprecations that are *not* selected.
+   *
+   * These deprecations must be selected by {@link include}.
+   */
+  exclude: DeprecationOrId | DeprecationOrId[];
+}
+
 /**
  * The possible statuses that each deprecation can have.
  *
- * "active" deprecations are currently emitting deprecation warnings.
- * "future" deprecations are not yet active, but will be in the future.
- * "obsolete" deprecations were once active, but no longer are.
+ * * "active" deprecations are currently emitting deprecation warnings.
+ * * "future" deprecations are not yet active, but will be in the future.
+ * * "obsolete" deprecations were once active, but no longer are.
  *
  * The only "user" deprecation is "user-authored", which is used for deprecation
  * warnings coming from user code.
@@ -303,10 +352,26 @@ export class Version {
   static parse(version: string): Version;
 }
 
+/**
+ * Additional, non-deprecation properties available on the {@link deprecations}
+ * property.
+ *
+ * Due to TypeScript constraints, these must be declared separately to avoid
+ * violating the `Record` type. All of these fields are non-enumerable so it's
+ * still safe to iterate over all deprecations.
+ *
+ * @category Messages
+ * @compatibility dart: "1.106.0", node: false
+ */
+export interface DeprecationsUtil {
+  /** Selects all deprecations that will become errors in Dart Sass 2.0.0. */
+  dartSass2: DeprecationSelector;
+}
+
 /**
  * An object containing all deprecation types.
  *
  * @category Messages
  * @compatibility dart: "1.74.0", node: false
  */
-export const deprecations: Deprecations;
+export const deprecations: Deprecations & DeprecationsUtil;

package/types/index.d.ts

@@ -17,7 +17,10 @@ export {
   deprecations,
   Deprecation,
   Deprecations,
+  DeprecationsUtil,
   DeprecationOrId,
+  DeprecationSelector,
+  DeprecationSelectorDifference,
   DeprecationStatus,
   Version,
 } from './deprecations';

package/types/options.d.ts

@@ -1,4 +1,4 @@
-import {DeprecationOrId, Version} from './deprecations';
+import {DeprecationOrId, DeprecationSelector} from './deprecations';
 import {FileImporter, Importer, NodePackageImporter} from './importer';
 import {Logger} from './logger';
 import {Value} from './value';
@@ -126,16 +126,13 @@ export interface Options<sync extends 'sync' | 'async'> {
   /**
    * A set of deprecations to treat as fatal.
    *
-   * If a deprecation warning of any provided type is encountered during
+   * If a deprecation warning of any selected type is encountered during
    * compilation, the compiler will error instead.
    *
-   * If a `Version` is provided, then all deprecations that were active in that
-   * compiler version will be treated as fatal.
-   *
    * @category Messages
    * @compatiblity dart: "1.74.0", node: false
    */
-  fatalDeprecations?: (DeprecationOrId | Version)[];
+  fatalDeprecations?: DeprecationSelector;
 
   /**
    * Additional built-in Sass functions that are available in all stylesheets.
@@ -221,8 +218,12 @@ export interface Options<sync extends 'sync' | 'async'> {
    *
    * @category Messages
    * @compatiblity dart: "1.74.0", node: false
+   * @compatiblity dart: feature: "single value", "1.106.0", node: false
+   *
+   * Prior to Dart Sass 1.106.0, this field could only take a list, not an
+   * individual {@link DeprecationOrId}.
    */
-  futureDeprecations?: DeprecationOrId[];
+  futureDeprecations?: DeprecationOrId | DeprecationOrId[];
 
   /**
    * Custom importers that control how Sass resolves loads from rules like
@@ -330,8 +331,12 @@ export interface Options<sync extends 'sync' | 'async'> {
    *
    * @category Messages
    * @compatiblity dart: "1.74.0", node: false
+   * @compatiblity dart: feature: "single value", "1.106.0", node: false
+   *
+   * Prior to Dart Sass 1.106.0, this field could only take a list, not an
+   * individual {@link DeprecationOrId}.
    */
-  silenceDeprecations?: DeprecationOrId[];
+  silenceDeprecations?: DeprecationOrId | DeprecationOrId[];
 
   /**
    * Whether or not Sass should generate a source map. If it does, the source