@atlaspack/utils 3.0.4-dev-yarn-8750a7d2e.0 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaspack/utils
 
+## 3.1.0
+
+### Minor Changes
+
+- [#852](https://github.com/atlassian-labs/atlaspack/pull/852) [`5776be2`](https://github.com/atlassian-labs/atlaspack/commit/5776be21f70a3f2b9471ba33da3ba1a883f21f1a) Thanks [@marcins](https://github.com/marcins)! - Support passing a function for source property in schema validation to allow for deferred reads of files
+
+### Patch Changes
+
+- Updated dependencies [[`02f6aa1`](https://github.com/atlassian-labs/atlaspack/commit/02f6aa1906953fc184d2b49c905c2ef815cb878d), [`58527ee`](https://github.com/atlassian-labs/atlaspack/commit/58527eec15c1aebaaadbeb63586f3082c16beae3), [`525898e`](https://github.com/atlassian-labs/atlaspack/commit/525898e33cc229a4bc938ae853732be36d20c01a), [`cfb39a0`](https://github.com/atlassian-labs/atlaspack/commit/cfb39a0d729eb620cf2ca1611750a2bf7a080d08), [`d0c7bea`](https://github.com/atlassian-labs/atlaspack/commit/d0c7bea04458255b4c5d4299600e734b5f919fe1), [`1086c6a`](https://github.com/atlassian-labs/atlaspack/commit/1086c6a2c59271b63b3fb78e6acdb9d3a0dbf354), [`9cd9521`](https://github.com/atlassian-labs/atlaspack/commit/9cd9521978f783046e2ae4ce78f2de7aeb07d073), [`5776be2`](https://github.com/atlassian-labs/atlaspack/commit/5776be21f70a3f2b9471ba33da3ba1a883f21f1a)]:
+  - @atlaspack/rust@3.9.0
+  - @atlaspack/feature-flags@2.26.0
+  - @atlaspack/logger@2.14.28
+  - @atlaspack/types-internal@2.20.6
+  - @atlaspack/codeframe@2.13.18
+
 ## 3.0.3
 
 ### Patch Changes

package/dist/config.js

@@ -13,8 +13,8 @@ const path_1 = __importDefault(require("path"));
 const clone_1 = __importDefault(require("clone"));
 const json5_1 = __importDefault(require("json5"));
 const toml_1 = require("@iarna/toml");
-// @ts-expect-error TS7016
 const lru_cache_1 = __importDefault(require("lru-cache"));
+// @ts-expect-error TS2351
 const configCache = new lru_cache_1.default({ max: 500 });
 const resolveCache = new Map();
 function resolveConfig(fs, filepath, filenames, projectRoot) {

package/dist/schema.js

@@ -280,18 +280,30 @@ function fuzzySearch(expectedValues, actualValue) {
     return result.map(([v]) => v);
 }
 validateSchema.diagnostic = function (schema, data, origin, message) {
-    if ('source' in data &&
-        'data' in data &&
-        typeof data.source !== 'string' &&
-        !data) {
-        throw new Error('At least one of data.source and data.data must be defined!');
+    if (!('map' in data) && !('source' in data || 'data' in data)) {
+        throw new Error('At least one of data.source, data.data, or data.map must be defined!');
+    }
+    let loadedSource;
+    function loadSource(loader) {
+        if (loadedSource !== undefined) {
+            return loadedSource;
+        }
+        else if (typeof loader === 'function') {
+            loadedSource = loader();
+            return loadedSource;
+        }
+        else if (typeof loader === 'string') {
+            loadedSource = loader;
+            return loadedSource;
+        }
+        return loadedSource;
     }
     // @ts-expect-error TS2339
     let object = data.map
         ? // @ts-expect-error TS2339
             data.map.data
         : // @ts-expect-error TS2339
-            (data.data ?? JSON.parse(data.source));
+            (data.data ?? JSON.parse(loadSource(data.source)));
     let errors = validateSchema(schema, object);
     if (errors.length) {
         let keys = errors.map((e) => {
@@ -358,11 +370,13 @@ validateSchema.diagnostic = function (schema, data, origin, message) {
         if (data.map) {
             // @ts-expect-error TS2339
             map = data.map;
-            code = data.source;
+            code = loadSource(data.source);
         }
         else {
-            // @ts-expect-error TS2339
-            map = data.source ?? JSON.stringify((0, nullthrows_1.default)(data.data), 0, '\t');
+            map =
+                loadSource(data.source) ??
+                    // @ts-expect-error TS2339
+                    JSON.stringify((0, nullthrows_1.default)(data.data), 0, '\t');
             code = map;
         }
         let codeFrames = [

package/lib/config.js

@@ -52,8 +52,7 @@ function _lruCache() {
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // @ts-expect-error TS7016
 
-// @ts-expect-error TS7016
-
+// @ts-expect-error TS2351
 const configCache = new (_lruCache().default)({
   max: 500
 });

package/lib/schema.js

@@ -252,15 +252,28 @@ function fuzzySearch(expectedValues, actualValue) {
   return result.map(([v]) => v);
 }
 validateSchema.diagnostic = function (schema, data, origin, message) {
-  if ('source' in data && 'data' in data && typeof data.source !== 'string' && !data) {
-    throw new Error('At least one of data.source and data.data must be defined!');
+  if (!('map' in data) && !('source' in data || 'data' in data)) {
+    throw new Error('At least one of data.source, data.data, or data.map must be defined!');
+  }
+  let loadedSource;
+  function loadSource(loader) {
+    if (loadedSource !== undefined) {
+      return loadedSource;
+    } else if (typeof loader === 'function') {
+      loadedSource = loader();
+      return loadedSource;
+    } else if (typeof loader === 'string') {
+      loadedSource = loader;
+      return loadedSource;
+    }
+    return loadedSource;
   }
   // @ts-expect-error TS2339
   let object = data.map ?
   // @ts-expect-error TS2339
   data.map.data :
   // @ts-expect-error TS2339
-  data.data ?? JSON.parse(data.source);
+  data.data ?? JSON.parse(loadSource(data.source));
   let errors = validateSchema(schema, object);
   if (errors.length) {
     let keys = errors.map(e => {
@@ -323,10 +336,11 @@ validateSchema.diagnostic = function (schema, data, origin, message) {
     if (data.map) {
       // @ts-expect-error TS2339
       map = data.map;
-      code = data.source;
+      code = loadSource(data.source);
     } else {
+      map = loadSource(data.source) ??
       // @ts-expect-error TS2339
-      map = data.source ?? JSON.stringify((0, _nullthrows().default)(data.data), 0, '\t');
+      JSON.stringify((0, _nullthrows().default)(data.data), 0, '\t');
       code = map;
     }
     let codeFrames = [{

package/lib/types/schema.d.ts

@@ -88,10 +88,10 @@ export type SchemaError = {
 declare function validateSchema(schema: SchemaEntity, data: unknown): Array<SchemaError>;
 declare namespace validateSchema {
     var diagnostic: (schema: SchemaEntity, data: ({
-        source?: string | null | undefined;
+        source?: (() => string) | string | null | undefined;
         data?: unknown;
     } | {
-        source: string;
+        source: string | (() => string);
         map: {
             data: unknown;
             pointers: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaspack/utils",
-  "version": "3.0.4-dev-yarn-8750a7d2e.0",
+  "version": "3.1.0",
   "description": "Blazing fast, zero configuration web application bundler",
   "license": "(MIT OR Apache-2.0)",
   "publishConfig": {
@@ -31,19 +31,20 @@
     }
   },
   "dependencies": {
-    "@atlaspack/codeframe": "2.13.18-dev-yarn-8750a7d2e.0",
-    "@atlaspack/diagnostic": "2.14.5-dev-yarn-8750a7d2e.0",
-    "@atlaspack/feature-flags": "2.25.6-dev-yarn-8750a7d2e.0",
-    "@atlaspack/logger": "2.14.28-dev-yarn-8750a7d2e.0",
-    "@atlaspack/markdown-ansi": "2.14.5-dev-yarn-8750a7d2e.0",
-    "@atlaspack/rust": "3.8.4-dev-yarn-8750a7d2e.0",
-    "@atlaspack/types-internal": "2.20.6-dev-yarn-8750a7d2e.0",
-    "@iarna/toml": "^2.2.3",
+    "@atlaspack/codeframe": "2.13.18",
+    "@atlaspack/diagnostic": "2.14.4",
+    "@atlaspack/feature-flags": "2.26.0",
+    "@atlaspack/logger": "2.14.28",
+    "@atlaspack/markdown-ansi": "2.14.4",
+    "@atlaspack/types-internal": "2.20.6",
+    "@atlaspack/rust": "3.9.0",
     "@parcel/source-map": "^2.1.1",
     "@types/micromatch": "^4.0.9",
     "@types/node-forge": "^1.3.13",
-    "ansi-html-community": "0.0.8",
     "chalk": "^4.1.0",
+    "nullthrows": "^1.1.1",
+    "@iarna/toml": "^2.2.0",
+    "ansi-html-community": "0.0.8",
     "clone": "^2.1.1",
     "fast-glob": "^3.2.12",
     "fastest-levenshtein": "^1.0.16",
@@ -53,14 +54,13 @@
     "lru-cache": "^6.0.0",
     "micromatch": "^4.0.4",
     "node-forge": "^1.2.1",
-    "nullthrows": "^1.1.1",
     "open": "^7.0.3",
     "snarkdown": "^2.0.0",
     "strip-ansi": "^6.0.0",
     "terminal-link": "^2.1.1"
   },
   "devDependencies": {
-    "@atlaspack/babel-register": "2.14.5-dev-yarn-8750a7d2e.0",
+    "@atlaspack/babel-register": "2.14.4",
     "@types/is-glob": "^4.0.1",
     "benny": "^3.7.1",
     "random-int": "^1.0.0"
@@ -74,6 +74,5 @@
   "type": "commonjs",
   "scripts": {
     "build:lib": "gulp build --gulpfile ../../../gulpfile.js --cwd ."
-  },
-  "gitHead": "8750a7d2e6330244dd618c28a20d5a391080e4a3"
+  }
 }

package/src/config.ts

@@ -6,7 +6,6 @@ import path from 'path';
 import clone from 'clone';
 import json5 from 'json5';
 import {parse as toml} from '@iarna/toml';
-// @ts-expect-error TS7016
 import LRU from 'lru-cache';
 
 export type ConfigOutput = {
@@ -19,6 +18,7 @@ export type ConfigOptions = {
   parser?: (arg1: string) => any;
 };
 
+// @ts-expect-error TS2351
 const configCache = new LRU<FilePath, ConfigOutput>({max: 500});
 const resolveCache = new Map();
 

package/src/schema.ts

@@ -391,11 +391,11 @@ validateSchema.diagnostic = function (
   schema: SchemaEntity,
   data: (
     | {
-        source?: string | null | undefined;
+        source?: (() => string) | string | null | undefined;
         data?: unknown;
       }
     | {
-        source: string;
+        source: string | (() => string);
         map: {
           data: unknown;
           pointers: {
@@ -410,22 +410,32 @@ validateSchema.diagnostic = function (
   origin: string,
   message: string,
 ): undefined {
-  if (
-    'source' in data &&
-    'data' in data &&
-    typeof data.source !== 'string' &&
-    !data
-  ) {
+  if (!('map' in data) && !('source' in data || 'data' in data)) {
     throw new Error(
-      'At least one of data.source and data.data must be defined!',
+      'At least one of data.source, data.data, or data.map must be defined!',
     );
   }
+  let loadedSource: string | null | undefined;
+  function loadSource(
+    loader: string | (() => string) | null | undefined,
+  ): string | null | undefined {
+    if (loadedSource !== undefined) {
+      return loadedSource;
+    } else if (typeof loader === 'function') {
+      loadedSource = loader();
+      return loadedSource;
+    } else if (typeof loader === 'string') {
+      loadedSource = loader;
+      return loadedSource;
+    }
+    return loadedSource;
+  }
   // @ts-expect-error TS2339
   let object = data.map
     ? // @ts-expect-error TS2339
       data.map.data
     : // @ts-expect-error TS2339
-      (data.data ?? JSON.parse(data.source));
+      (data.data ?? JSON.parse(loadSource(data.source)));
   let errors = validateSchema(schema, object);
   if (errors.length) {
     let keys = errors.map((e) => {
@@ -487,10 +497,12 @@ validateSchema.diagnostic = function (
     if (data.map) {
       // @ts-expect-error TS2339
       map = data.map;
-      code = data.source;
+      code = loadSource(data.source);
     } else {
-      // @ts-expect-error TS2339
-      map = data.source ?? JSON.stringify(nullthrows(data.data), 0, '\t');
+      map =
+        loadSource(data.source) ??
+        // @ts-expect-error TS2339
+        JSON.stringify(nullthrows(data.data), 0, '\t');
       code = map;
     }
     let codeFrames = [