sass 1.45.0-rc.2 → 1.46.0

package/types/compile.d.ts

@@ -1,4 +1,3 @@
-import {URL} from 'url';
 import {RawSourceMap} from 'source-map-js';
 
 import {Options, StringOptions} from './options';

package/types/importer.d.ts

@@ -1,5 +1,3 @@
-import {URL} from 'url';
-
 import {Syntax} from './options';
 import {PromiseOr} from './util/promise_or';
 

package/types/index.d.ts

@@ -42,8 +42,9 @@ export {
 export {LegacyException} from './legacy/exception';
 export {
   LegacyAsyncFunction,
-  LegacySyncFunction,
+  LegacyAsyncFunctionDone,
   LegacyFunction,
+  LegacySyncFunction,
   LegacyValue,
   types,
 } from './legacy/function';

package/types/legacy/function.d.ts

@@ -68,9 +68,10 @@ export type LegacySyncFunction = (
  * });
  * ```
  *
- * @param args - One argument for each argument that's declared in the signature
- * that's passed to [[LegacySharedOptions.functions]]. If the signature [takes
- * arbitrary arguments](https://sass-lang.com/documentation/at-rules/function#taking-arbitrary-arguments),
+ * This is passed one argument for each argument that's declared in the
+ * signature that's passed to [[LegacySharedOptions.functions]]. If the
+ * signature [takes arbitrary
+ * arguments](https://sass-lang.com/documentation/at-rules/function#taking-arbitrary-arguments),
  * they're passed as a single argument list in the last argument before the
  * callback.
  *
@@ -79,9 +80,73 @@ export type LegacySyncFunction = (
  * APIs. Use [[CustomFunction]] with [[compile]], [[compileString]],
  * [[compileAsync]], and [[compileStringAsync]] instead.
  */
-export type LegacyAsyncFunction = (
-  this: LegacyPluginThis,
-  ...args: [...LegacyValue[], (result: LegacyValue) => void]
+export type LegacyAsyncFunction =
+  | ((this: LegacyPluginThis, done: (result: LegacyValue) => void) => void)
+  | ((
+      this: LegacyPluginThis,
+      arg1: LegacyValue,
+      done: LegacyAsyncFunctionDone
+    ) => void)
+  | ((
+      this: LegacyPluginThis,
+      arg1: LegacyValue,
+      arg2: LegacyValue,
+      done: LegacyAsyncFunctionDone
+    ) => void)
+  | ((
+      this: LegacyPluginThis,
+      arg1: LegacyValue,
+      arg2: LegacyValue,
+      arg3: LegacyValue,
+      done: LegacyAsyncFunctionDone
+    ) => void)
+  | ((
+      this: LegacyPluginThis,
+      arg1: LegacyValue,
+      arg2: LegacyValue,
+      arg3: LegacyValue,
+      arg4: LegacyValue,
+      done: LegacyAsyncFunctionDone
+    ) => void)
+  | ((
+      this: LegacyPluginThis,
+      arg1: LegacyValue,
+      arg2: LegacyValue,
+      arg3: LegacyValue,
+      arg4: LegacyValue,
+      arg5: LegacyValue,
+      done: LegacyAsyncFunctionDone
+    ) => void)
+  | ((
+      this: LegacyPluginThis,
+      arg1: LegacyValue,
+      arg2: LegacyValue,
+      arg3: LegacyValue,
+      arg4: LegacyValue,
+      arg5: LegacyValue,
+      arg6: LegacyValue,
+      done: LegacyAsyncFunctionDone
+    ) => void)
+  | ((
+      this: LegacyPluginThis,
+      ...args: [...LegacyValue[], LegacyAsyncFunctionDone]
+    ) => void);
+
+/**
+ * The function called by a [[LegacyAsyncFunction]] to indicate that it's
+ * finished.
+ *
+ * @param result - If this is a [[LegacyValue]], that indicates that the
+ * function call completed successfully. If it's a [[types.Error]], that
+ * indicates that the function call failed.
+ *
+ * @category Legacy
+ * @deprecated This only works with the legacy [[render]] and [[renderSync]]
+ * APIs. Use [[CustomFunction]] with [[compile]], [[compileString]],
+ * [[compileAsync]], and [[compileStringAsync]] instead.
+ */
+export type LegacyAsyncFunctionDone = (
+  result: LegacyValue | types.Error
 ) => void;
 
 /**
@@ -649,4 +714,13 @@ export namespace types {
      */
     getLength(): number;
   }
+
+  /**
+   * An error that can be returned from a Sass function to signal that it
+   * encountered an error. This is the only way to signal an error
+   * asynchronously from a [[LegacyAsyncFunction]].
+   */
+  export class Error {
+    constructor(message: string);
+  }
 }

package/types/legacy/options.d.ts

@@ -553,7 +553,7 @@ export interface LegacyFileOptions<sync extends 'sync' | 'async'>
    *
    * @category Input
    */
-  data: never;
+  data?: never;
 }
 
 /**

package/types/legacy/plugin_this.d.ts

@@ -13,6 +13,9 @@ export interface LegacyPluginThis {
    * [[renderSync]].
    */
   options: {
+    /** The same [[LegacyPluginThis]] instance that contains this object. */
+    context: LegacyPluginThis;
+
     /**
      * The value passed to [[LegacyFileOptions.file]] or
      * [[LegacyStringOptions.file]].

package/types/logger/source_span.d.ts

@@ -1,5 +1,3 @@
-import {URL} from 'url';
-
 import {SourceLocation} from './source_location';
 
 /**

package/types/options.d.ts

@@ -1,5 +1,3 @@
-import {URL} from 'url';
-
 import {FileImporter, Importer} from './importer';
 import {Logger} from './logger';
 import {Value} from './value';