@stackbit/types - npm Package Compare versions

Comparing version 0.11.4-develop.1 to 0.11.4-develop.2

dist/utils.d.ts

@@ -6,2 +6,3 @@ import type { Version } from './content-source';
 import type { DocumentField, DocumentFieldForType, DocumentFieldLocalized, DocumentFieldNonLocalizedForType } from './content-source-document-fields';
+export declare function loadJSON(filePath: string): Promise<any>;
 export declare function getInterfaceVersion(): Promise<any>;
@@ -8,0 +9,0 @@ export declare function getVersion(options?: {

dist/utils.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AACpH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,KAAK,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzF,OAAO,KAAK,EACR,aAAa,EACb,oBAAoB,EACpB,sBAAsB,EACtB,gCAAgC,EACnC,MAAM,kCAAkC,CAAC;AAS1C,wBAAsB,mBAAmB,iBAGxC;AAED,wBAAsB,UAAU,CAC5B,OAAO,GAAE;IAAE,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAAO,GAC1E,OAAO,CAAC,OAAO,CAAC,CAmBlB;AAED,wBAAgB,gBAAgB,CAC5B,KAAK,EAAE,aAAa,GAAG,cAAc,GACtC,KAAK,IAAI,sBAAsB,GAAG,uBAAuB,CAE3D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,SAAS,SAAS,EAC7D,KAAK,CAAC,EAAE,oBAAoB,CAAC,IAAI,CAAC,EAClC,MAAM,CAAC,EAAE,MAAM,GAChB,gCAAgC,CAAC,IAAI,CAAC,GAAG,SAAS,CAgBpD;AAED,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,SAAS,EACjD,SAAS,EAAE,SAAS,EACpB,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC7B,SAAS,IAAI,CAAC,CAEhB;AAED,wBAAgB,2BAA2B,CAAC,CAAC,SAAS,SAAS,EAC3D,UAAU,EAAE,KAAK,EACjB,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC7B,UAAU,IAAI,YAAY,CAAC,CAAC,CAAC,CAE/B;AAED,wBAAgB,wCAAwC,CAAC,CAAC,SAAS,SAAS,EACxE,UAAU,EAAE,kBAAkB,EAC9B,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC7B,UAAU,IAAI,yBAAyB,CAAC,CAAC,CAAC,CAE5C;AAED,wBAAgB,8BAA8B,CAAC,CAAC,SAAS,SAAS,EAC9D,aAAa,EAAE,aAAa,EAC5B,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC7B,aAAa,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAE1C;AAED,wBAAgB,oBAAoB,CAAC,cAAc,EAAE,cAAc,kBAElE"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AACpH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,KAAK,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzF,OAAO,KAAK,EACR,aAAa,EACb,oBAAoB,EACpB,sBAAsB,EACtB,gCAAgC,EACnC,MAAM,kCAAkC,CAAC;AAE1C,wBAAsB,QAAQ,CAAC,QAAQ,EAAE,MAAM,gBAa9C;AAED,wBAAsB,mBAAmB,iBAIxC;AAED,wBAAsB,UAAU,CAC5B,OAAO,GAAE;IAAE,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAAO,GAC1E,OAAO,CAAC,OAAO,CAAC,CAmBlB;AAED,wBAAgB,gBAAgB,CAC5B,KAAK,EAAE,aAAa,GAAG,cAAc,GACtC,KAAK,IAAI,sBAAsB,GAAG,uBAAuB,CAE3D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,SAAS,SAAS,EAC7D,KAAK,CAAC,EAAE,oBAAoB,CAAC,IAAI,CAAC,EAClC,MAAM,CAAC,EAAE,MAAM,GAChB,gCAAgC,CAAC,IAAI,CAAC,GAAG,SAAS,CAgBpD;AAED,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,SAAS,EACjD,SAAS,EAAE,SAAS,EACpB,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC7B,SAAS,IAAI,CAAC,CAEhB;AAED,wBAAgB,2BAA2B,CAAC,CAAC,SAAS,SAAS,EAC3D,UAAU,EAAE,KAAK,EACjB,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC7B,UAAU,IAAI,YAAY,CAAC,CAAC,CAAC,CAE/B;AAED,wBAAgB,wCAAwC,CAAC,CAAC,SAAS,SAAS,EACxE,UAAU,EAAE,kBAAkB,EAC9B,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC7B,UAAU,IAAI,yBAAyB,CAAC,CAAC,CAAC,CAE5C;AAED,wBAAgB,8BAA8B,CAAC,CAAC,SAAS,SAAS,EAC9D,aAAa,EAAE,aAAa,EAC5B,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC7B,aAAa,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAE1C;AAED,wBAAgB,oBAAoB,CAAC,cAAc,EAAE,cAAc,kBAElE"}

dist/utils.js

 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defineStackbitConfig = exports.isDocumentFieldOneOfFieldTypes = exports.isModelFieldSpecificPropsOneOfFieldTypes = exports.isModelFieldOneOfFieldTypes = exports.isOneOfFieldTypes = exports.getLocalizedFieldForLocale = exports.isLocalizedField = exports.getVersion = exports.getInterfaceVersion = void 0;
-const path_1 = __importDefault(require("path"));
-const promises_1 = __importDefault(require("fs/promises"));
-const loadJSON = async (path) => JSON.parse(await promises_1.default.readFile(path, {
-    encoding: `utf8`
-}));
+exports.defineStackbitConfig = exports.isDocumentFieldOneOfFieldTypes = exports.isModelFieldSpecificPropsOneOfFieldTypes = exports.isModelFieldOneOfFieldTypes = exports.isOneOfFieldTypes = exports.getLocalizedFieldForLocale = exports.isLocalizedField = exports.getVersion = exports.getInterfaceVersion = exports.loadJSON = void 0;
+async function loadJSON(filePath) {
+    // The `@stackbit/pacakge` can be imported in browser environment. To use
+    // the types in client-side's code, or when using the
+    // `getLocalizedFieldForLocale` utility method.
+    // Therefore, don't use `require('fs/promises')`, as bundlers will try to
+    // bundle the inline `fs/promises` and browser will not be able to load it.
+    const module = 'fs/promises';
+    const fs = require(module);
+    return JSON.parse(await fs.readFile(filePath, {
+        encoding: `utf8`
+    }));
+}
+exports.loadJSON = loadJSON;
 async function getInterfaceVersion() {
-    const packageJson = await loadJSON(path_1.default.join(__dirname, '../package.json'));
+    const path = require('path');
+    const packageJson = await loadJSON(path.join(__dirname, '../package.json'));
     return packageJson.version;
@@ -15,0 +21,0 @@ }

dist/utils.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,2DAA6B;AAY7B,MAAM,QAAQ,GAAG,KAAK,EAAE,IAAY,EAAE,EAAE,CACpC,IAAI,CAAC,KAAK,CACN,MAAM,kBAAE,CAAC,QAAQ,CAAC,IAAI,EAAE;IACpB,QAAQ,EAAE,MAAM;CACnB,CAAC,CACL,CAAC;AAEC,KAAK,UAAU,mBAAmB;IACrC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAC5E,OAAO,WAAW,CAAC,OAAO,CAAC;AAC/B,CAAC;AAHD,kDAGC;AAEM,KAAK,UAAU,UAAU,CAC5B,UAAuE,EAAE;IAEzE,MAAM,gBAAgB,GAAG,MAAM,mBAAmB,EAAE,CAAC;IACrD,IAAI,OAAO,CAAC,oBAAoB,EAAE;QAC9B,OAAO;YACH,gBAAgB,EAAE,gBAAgB;YAClC,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;SACrD,CAAC;KACL;SAAM,IAAI,OAAO,CAAC,eAAe,EAAE;QAChC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAC5D,OAAO;YACH,gBAAgB,EAAE,gBAAgB;YAClC,oBAAoB,EAAE,WAAW,CAAC,OAAO;SAC5C,CAAC;KACL;SAAM;QACH,OAAO;YACH,gBAAgB,EAAE,gBAAgB;YAClC,oBAAoB,EAAE,EAAE;SAC3B,CAAC;KACL;AACL,CAAC;AArBD,gCAqBC;AAED,SAAgB,gBAAgB,CAC5B,KAAqC;IAErC,OAAO,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;AAC7B,CAAC;AAJD,4CAIC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,SAAgB,0BAA0B,CACtC,KAAkC,EAClC,MAAe;IAEf,IAAI,KAAK,IAAI,KAAK,CAAC,SAAS,EAAE;QAC1B,IAAI,CAAC,MAAM,EAAE;YACT,OAAO,SAAS,CAAC;SACpB;QACD,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;QAC9C,MAAM,cAAc,GAAG,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,cAAc,EAAE;YACjB,OAAO,SAAS,CAAC;SACpB;QACD,OAAO;YACH,GAAG,IAAI;YACP,GAAG,cAAc;SACiC,CAAC;KAC1D;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAnBD,gEAmBC;AAED,SAAgB,iBAAiB,CAC7B,SAAoB,EACpB,UAA4B;IAE5B,OAAO,UAAU,CAAC,QAAQ,CAAC,SAAc,CAAC,CAAC;AAC/C,CAAC;AALD,8CAKC;AAED,SAAgB,2BAA2B,CACvC,UAAiB,EACjB,UAA4B;IAE5B,OAAO,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAS,CAAC,CAAC;AACrD,CAAC;AALD,kEAKC;AAED,SAAgB,wCAAwC,CACpD,UAA8B,EAC9B,UAA4B;IAE5B,OAAO,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAS,CAAC,CAAC;AACrD,CAAC;AALD,4FAKC;AAED,SAAgB,8BAA8B,CAC1C,aAA4B,EAC5B,UAA4B;IAE5B,OAAO,UAAU,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAS,CAAC,CAAC;AACxD,CAAC;AALD,wEAKC;AAED,SAAgB,oBAAoB,CAAC,cAA8B;IAC/D,OAAO,cAAc,CAAC;AAC1B,CAAC;AAFD,oDAEC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAWO,KAAK,UAAU,QAAQ,CAAC,QAAgB;IAC3C,yEAAyE;IACzE,qDAAqD;IACrD,+CAA+C;IAC/C,yEAAyE;IACzE,2EAA2E;IAC3E,MAAM,MAAM,GAAG,aAAa,CAAC;IAC7B,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3B,OAAO,IAAI,CAAC,KAAK,CACb,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE;QACxB,QAAQ,EAAE,MAAM;KACnB,CAAC,CACL,CAAC;AACN,CAAC;AAbD,4BAaC;AAEM,KAAK,UAAU,mBAAmB;IACrC,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7B,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAC5E,OAAO,WAAW,CAAC,OAAO,CAAC;AAC/B,CAAC;AAJD,kDAIC;AAEM,KAAK,UAAU,UAAU,CAC5B,UAAuE,EAAE;IAEzE,MAAM,gBAAgB,GAAG,MAAM,mBAAmB,EAAE,CAAC;IACrD,IAAI,OAAO,CAAC,oBAAoB,EAAE;QAC9B,OAAO;YACH,gBAAgB,EAAE,gBAAgB;YAClC,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;SACrD,CAAC;KACL;SAAM,IAAI,OAAO,CAAC,eAAe,EAAE;QAChC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAC5D,OAAO;YACH,gBAAgB,EAAE,gBAAgB;YAClC,oBAAoB,EAAE,WAAW,CAAC,OAAO;SAC5C,CAAC;KACL;SAAM;QACH,OAAO;YACH,gBAAgB,EAAE,gBAAgB;YAClC,oBAAoB,EAAE,EAAE;SAC3B,CAAC;KACL;AACL,CAAC;AArBD,gCAqBC;AAED,SAAgB,gBAAgB,CAC5B,KAAqC;IAErC,OAAO,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;AAC7B,CAAC;AAJD,4CAIC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,SAAgB,0BAA0B,CACtC,KAAkC,EAClC,MAAe;IAEf,IAAI,KAAK,IAAI,KAAK,CAAC,SAAS,EAAE;QAC1B,IAAI,CAAC,MAAM,EAAE;YACT,OAAO,SAAS,CAAC;SACpB;QACD,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;QAC9C,MAAM,cAAc,GAAG,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,cAAc,EAAE;YACjB,OAAO,SAAS,CAAC;SACpB;QACD,OAAO;YACH,GAAG,IAAI;YACP,GAAG,cAAc;SACiC,CAAC;KAC1D;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAnBD,gEAmBC;AAED,SAAgB,iBAAiB,CAC7B,SAAoB,EACpB,UAA4B;IAE5B,OAAO,UAAU,CAAC,QAAQ,CAAC,SAAc,CAAC,CAAC;AAC/C,CAAC;AALD,8CAKC;AAED,SAAgB,2BAA2B,CACvC,UAAiB,EACjB,UAA4B;IAE5B,OAAO,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAS,CAAC,CAAC;AACrD,CAAC;AALD,kEAKC;AAED,SAAgB,wCAAwC,CACpD,UAA8B,EAC9B,UAA4B;IAE5B,OAAO,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAS,CAAC,CAAC;AACrD,CAAC;AALD,4FAKC;AAED,SAAgB,8BAA8B,CAC1C,aAA4B,EAC5B,UAA4B;IAE5B,OAAO,UAAU,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAS,CAAC,CAAC;AACxD,CAAC;AALD,wEAKC;AAED,SAAgB,oBAAoB,CAAC,cAA8B;IAC/D,OAAO,cAAc,CAAC;AAC1B,CAAC;AAFD,oDAEC"}

package.json

 {
   "name": "@stackbit/types",
-  "version": "0.11.4-develop.1",
+  "version": "0.11.4-develop.2",
   "description": "Types for Stackbit config and Content Source Interface",
@@ -30,3 +30,3 @@ "main": "dist/index.js",
   "homepage": "https://github.com/stackbit/stackbit#readme",
-  "gitHead": "e53aeb2efdf141c4e61d3c7cb29864a021d86d79"
+  "gitHead": "8f69266a6a553ab4e808fe5df875eccf93cdd51c"
 }

src/utils.ts

@@ -1,3 +0,1 @@
-import path from 'path';
-import fs from 'fs/promises';
 import type { Version } from './content-source';
@@ -14,10 +12,19 @@ import type { FieldType, Field, FieldForType, FieldSpecificProps, FieldSpecificPropsForType } from './model-fields';
 
-const loadJSON = async (path: string) =>
-    JSON.parse(
-        await fs.readFile(path, {
+export async function loadJSON(filePath: string) {
+    // The `@stackbit/pacakge` can be imported in browser environment. To use
+    // the types in client-side's code, or when using the
+    // `getLocalizedFieldForLocale` utility method.
+    // Therefore, don't use `require('fs/promises')`, as bundlers will try to
+    // bundle the inline `fs/promises` and browser will not be able to load it.
+    const module = 'fs/promises';
+    const fs = require(module);
+    return JSON.parse(
+        await fs.readFile(filePath, {
             encoding: `utf8`
         })
     );
+}
 
 export async function getInterfaceVersion() {
+    const path = require('path');
     const packageJson = await loadJSON(path.join(__dirname, '../package.json'));
@@ -24,0 +31,0 @@ return packageJson.version;

New alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Fixed alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Improved metrics

Total package byte prevSize

374113

0.25%

Lines of code

6744

0.21%

No dependency changes