@atlaspack/transformer-sass 2.14.21 → 2.14.22-typescript-5ad950d33.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2024 Atlassian US., Inc.
+
+   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
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/lib/SassTransformer.d.ts

@@ -0,0 +1,3 @@
+import { Transformer } from '@atlaspack/plugin';
+declare const _default: Transformer<unknown>;
+export default _default;

package/lib/SassTransformer.js

@@ -47,6 +47,8 @@ function _util() {
   return data;
 }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// @ts-expect-error TS7016
+
 // E.g: ~library/file.sass
 const NODE_MODULE_ALIAS_RE = /^~[^/\\]/;
 var _default = exports.default = new (_plugin().Transformer)({
@@ -67,20 +69,31 @@ var _default = exports.default = new (_plugin().Transformer)({
     }
 
     // Resolve relative paths from config file
+    // @ts-expect-error TS18046
     if (configFile && configResult.includePaths) {
+      // @ts-expect-error TS18046
       configResult.includePaths = configResult.includePaths.map(p => _path().default.resolve(_path().default.dirname(configFile.filePath), p));
     }
+
+    // @ts-expect-error TS18046
     if (configResult.importer === undefined) {
+      // @ts-expect-error TS18046
       configResult.importer = [];
+      // @ts-expect-error TS18046
     } else if (!Array.isArray(configResult.importer)) {
+      // @ts-expect-error TS18046
       configResult.importer = [configResult.importer];
     }
 
     // Always emit sourcemap
+    // @ts-expect-error TS18046
     configResult.sourceMap = true;
     // sources are created relative to the directory of outFile
+    // @ts-expect-error TS18046
     configResult.outFile = _path().default.join(options.projectRoot, 'style.css.map');
+    // @ts-expect-error TS18046
     configResult.omitSourceMapUrl = true;
+    // @ts-expect-error TS18046
     configResult.sourceMapContents = false;
     return configResult;
   },
@@ -98,18 +111,22 @@ var _default = exports.default = new (_plugin().Transformer)({
       let result = await sassRender({
         ...rawConfig,
         file: asset.filePath,
-        // $FlowFixMe
+        // @ts-expect-error TS2339
         data: rawConfig.data ? rawConfig.data + _os().EOL + code : code,
         importer: [
-        // $FlowFixMe
+        // @ts-expect-error TS2339
         ...rawConfig.importer, resolvePathImporter({
           asset,
           resolve,
-          // $FlowFixMe
+          // @ts-expect-error TS2339
           includePaths: rawConfig.includePaths,
           options
         })],
-        indentedSyntax: typeof rawConfig.indentedSyntax === 'boolean' ? rawConfig.indentedSyntax : asset.type === 'sass'
+        indentedSyntax:
+        // @ts-expect-error TS2339
+        typeof rawConfig.indentedSyntax === 'boolean' ?
+        // @ts-expect-error TS2339
+        rawConfig.indentedSyntax : asset.type === 'sass'
       });
       css = result.css;
       for (let included of result.stats.includedFiles) {
@@ -135,7 +152,7 @@ var _default = exports.default = new (_plugin().Transformer)({
     asset.setCode(css);
     return [asset];
   }
-});
+}); // @ts-expect-error TS7031
 function resolvePathImporter({
   asset,
   resolve,
@@ -162,7 +179,9 @@ function resolvePathImporter({
     }
     asset.invalidateOnEnvChange('SASS_PATH');
     if (options.env.SASS_PATH) {
-      paths.push(...options.env.SASS_PATH.split(process.platform === 'win32' ? ';' : ':').map(p => _path().default.resolve(options.projectRoot, p)));
+      paths.push(...options.env.SASS_PATH.split(process.platform === 'win32' ? ';' : ':'
+      // @ts-expect-error TS7006
+      ).map(p => _path().default.resolve(options.projectRoot, p)));
     }
     const urls = [url];
     const urlFileName = _path().default.basename(url);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaspack/transformer-sass",
-  "version": "2.14.21",
+  "version": "2.14.22-typescript-5ad950d33.0",
   "license": "(MIT OR Apache-2.0)",
   "publishConfig": {
     "access": "public"
@@ -9,15 +9,20 @@
     "type": "git",
     "url": "https://github.com/atlassian-labs/atlaspack.git"
   },
-  "main": "lib/SassTransformer.js",
-  "source": "src/SassTransformer.js",
+  "main": "./lib/SassTransformer.js",
+  "source": "./src/SassTransformer.ts",
+  "types": "./lib/SassTransformer.d.ts",
   "engines": {
     "node": ">= 16.0.0"
   },
   "dependencies": {
-    "@atlaspack/plugin": "2.14.21",
+    "@atlaspack/plugin": "2.14.22-typescript-5ad950d33.0",
     "@parcel/source-map": "^2.1.1",
     "sass": "^1.38.0"
   },
-  "type": "commonjs"
-}
+  "type": "commonjs",
+  "scripts": {
+    "check-ts": "tsc --emitDeclarationOnly --rootDir src"
+  },
+  "gitHead": "5ad950d33a5f2255ebeb10c04a2e84c346e2de85"
+}

package/src/{SassTransformer.js → SassTransformer.ts}

@@ -1,15 +1,15 @@
-// @flow
 import {Transformer} from '@atlaspack/plugin';
 import path from 'path';
 import {EOL} from 'os';
 import SourceMap from '@parcel/source-map';
+// @ts-expect-error TS7016
 import sass from 'sass';
 import {promisify} from 'util';
 
 // E.g: ~library/file.sass
 const NODE_MODULE_ALIAS_RE = /^~[^/\\]/;
 
-export default (new Transformer({
+export default new Transformer({
   async loadConfig({config, options}) {
     let configFile = await config.getConfig(
       ['.sassrc', '.sassrc.json', '.sassrc.js', '.sassrc.cjs', '.sassrc.mjs'],
@@ -28,23 +28,33 @@ export default (new Transformer({
     }
 
     // Resolve relative paths from config file
+    // @ts-expect-error TS18046
     if (configFile && configResult.includePaths) {
+      // @ts-expect-error TS18046
       configResult.includePaths = configResult.includePaths.map((p) =>
         path.resolve(path.dirname(configFile.filePath), p),
       );
     }
 
+    // @ts-expect-error TS18046
     if (configResult.importer === undefined) {
+      // @ts-expect-error TS18046
       configResult.importer = [];
+      // @ts-expect-error TS18046
     } else if (!Array.isArray(configResult.importer)) {
+      // @ts-expect-error TS18046
       configResult.importer = [configResult.importer];
     }
 
     // Always emit sourcemap
+    // @ts-expect-error TS18046
     configResult.sourceMap = true;
     // sources are created relative to the directory of outFile
+    // @ts-expect-error TS18046
     configResult.outFile = path.join(options.projectRoot, 'style.css.map');
+    // @ts-expect-error TS18046
     configResult.omitSourceMapUrl = true;
+    // @ts-expect-error TS18046
     configResult.sourceMapContents = false;
 
     return configResult;
@@ -59,22 +69,24 @@ export default (new Transformer({
       let result = await sassRender({
         ...rawConfig,
         file: asset.filePath,
-        // $FlowFixMe
+        // @ts-expect-error TS2339
         data: rawConfig.data ? rawConfig.data + EOL + code : code,
         importer: [
-          // $FlowFixMe
+          // @ts-expect-error TS2339
           ...rawConfig.importer,
           resolvePathImporter({
             asset,
             resolve,
-            // $FlowFixMe
+            // @ts-expect-error TS2339
             includePaths: rawConfig.includePaths,
             options,
           }),
         ],
         indentedSyntax:
+          // @ts-expect-error TS2339
           typeof rawConfig.indentedSyntax === 'boolean'
-            ? rawConfig.indentedSyntax
+            ? // @ts-expect-error TS2339
+              rawConfig.indentedSyntax
             : asset.type === 'sass',
       });
 
@@ -90,7 +102,7 @@ export default (new Transformer({
         map.addVLQMap(JSON.parse(result.map));
         asset.setMap(map);
       }
-    } catch (err) {
+    } catch (err: any) {
       // Adapt the Error object for the reporter.
       err.fileName = err.file;
       err.loc = {
@@ -105,15 +117,22 @@ export default (new Transformer({
     asset.setCode(css);
     return [asset];
   },
-}): Transformer<mixed>);
+}) as Transformer<unknown>;
 
+// @ts-expect-error TS7031
 function resolvePathImporter({asset, resolve, includePaths, options}) {
   // This is a reimplementation of the Sass resolution algorithm that uses Atlaspack's
   // FS and tracks all tried files so they are watched for creation.
   async function resolvePath(
-    url,
-    prev,
-  ): Promise<{filePath: string, contents: string, ...} | void> {
+    url: any,
+    prev: any,
+  ): Promise<
+    | {
+        filePath: string;
+        contents: string;
+      }
+    | undefined
+  > {
     /*
       Imports are resolved by trying, in order:
         * Loading a file relative to the file in which the `@import` appeared.
@@ -136,6 +155,7 @@ function resolvePathImporter({asset, resolve, includePaths, options}) {
       paths.push(
         ...options.env.SASS_PATH.split(
           process.platform === 'win32' ? ';' : ':',
+          // @ts-expect-error TS7006
         ).map((p) => path.resolve(options.projectRoot, p)),
       );
     }
@@ -156,7 +176,7 @@ function resolvePathImporter({asset, resolve, includePaths, options}) {
               filePath,
               contents,
             };
-          } catch (err) {
+          } catch (err: any) {
             asset.invalidateOnFileCreate({filePath});
           }
         }
@@ -176,13 +196,13 @@ function resolvePathImporter({asset, resolve, includePaths, options}) {
           const contents = await asset.fs.readFile(filePath, 'utf8');
           return {filePath, contents};
         }
-      } catch (err) {
+      } catch (err: any) {
         continue;
       }
     }
   }
 
-  return function (rawUrl, prev, done) {
+  return function (rawUrl: any, prev: any, done: any) {
     const url = rawUrl.replace(/^file:\/\//, '');
     resolvePath(url, prev)
       .then((resolved) => {

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../../tsconfig.json",
+  "include": ["src"]
+}