@scalar/oas-utils 0.2.53 → 0.2.55

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @scalar/oas-utils
 
+## 0.2.55
+
+### Patch Changes
+
+- 0ddd4f3: feat: added virtual text component
+
+## 0.2.54
+
+### Patch Changes
+
+- 2ff5905: chore: cache results of getExampleFromSchema
+- 9a2d5ca: fix: schema model console log typo
+- e911047: Add default exports
+- Updated dependencies [e911047]
+- Updated dependencies [d02d70c]
+- Updated dependencies [3acbf26]
+  - @scalar/object-utils@1.1.10
+  - @scalar/openapi-types@0.1.2
+  - @scalar/types@0.0.14
+  - @scalar/themes@0.9.36
+
 ## 0.2.53
 
 ### Patch Changes

package/dist/helpers/parse.js

@@ -59,7 +59,7 @@ const transformToJson = (value) => {
 function formatJsonOrYamlString(value) {
     // If we don't start with a bracket assume yaml
     const trimmed = value.trim();
-    if (trimmed[0] !== '{')
+    if (trimmed[0] !== '{' && trimmed[0] !== '[')
         return value;
     try {
         // JSON

package/dist/helpers/schema-model.js

@@ -4,7 +4,7 @@ function schemaModel(data, schema, throwError = true, errorLocation) {
     if (!result.success) {
         console.group('Schema Error' + (errorLocation ? ` - ${errorLocation}` : ''));
         console.warn(JSON.stringify(result.error.format(), null, 2));
-        console.log('Recieved: ', data);
+        console.log('Received: ', data);
         console.groupEnd();
     }
     if (throwError && !result.success)

package/dist/spec-getters/getExampleFromSchema.d.ts

@@ -1,5 +1,5 @@
 /**
- * This function takes a properties object and generates an example response content.
+ * This function takes an OpenAPI schema and generates an example from it
  */
 export declare const getExampleFromSchema: (schema: Record<string, any>, options?: {
     /**

package/dist/spec-getters/getExampleFromSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getExampleFromSchema.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getExampleFromSchema.ts"],"names":[],"mappings":"AAyCA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC/B;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAA;CACzC,UACM,MAAM,iBACE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,SAC3B,MAAM,KACZ,GAgRF,CAAA"}
+{"version":3,"file":"getExampleFromSchema.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getExampleFromSchema.ts"],"names":[],"mappings":"AAwDA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC/B;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAA;CACzC,UACM,MAAM,iBACE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,SAC3B,MAAM,KACZ,GA2RF,CAAA"}

package/dist/spec-getters/getExampleFromSchema.js

@@ -1,5 +1,5 @@
 /** Hard limit for rendering circular references */
-const MAX_LEVELS_DEEP = 10;
+const MAX_LEVELS_DEEP = 5;
 const genericExampleValues = {
     // 'date-time': '1970-01-01T00:00:00Z',
     'date-time': new Date().toISOString(),
@@ -36,10 +36,25 @@ const genericExampleValues = {
 function guessFromFormat(schema, fallback = '') {
     return genericExampleValues[schema.format] ?? fallback;
 }
+/** Map of all the results */
+const resultCache = new WeakMap();
+/** Store result in the cache, and return the result */
+function cache(schema, result) {
+    // Avoid unnecessary WeakMap operations for primitive values
+    if (typeof result !== 'object' || result === null) {
+        return result;
+    }
+    resultCache.set(schema, result);
+    return result;
+}
 /**
- * This function takes a properties object and generates an example response content.
+ * This function takes an OpenAPI schema and generates an example from it
  */
 const getExampleFromSchema = (schema, options, level = 0, parentSchema, name) => {
+    // Check if the result is already cached
+    if (resultCache.has(schema)) {
+        return resultCache.get(schema);
+    }
     // Check whether it’s a circular reference
     if (level === MAX_LEVELS_DEEP + 1) {
         try {
@@ -67,24 +82,24 @@ const getExampleFromSchema = (schema, options, level = 0, parentSchema, name) =>
             if (schema.type === 'number' || schema.type === 'integer') {
                 return parseInt(value, 10);
             }
-            return value;
+            return cache(schema, value);
         }
     }
     // Use the first example, if there’s an array
     if (Array.isArray(schema.examples) && schema.examples.length > 0) {
-        return schema.examples[0];
+        return cache(schema, schema.examples[0]);
     }
     // Use an example, if there’s one
     if (schema.example !== undefined) {
-        return schema.example;
+        return cache(schema, schema.example);
     }
     // Use a default value, if there’s one
     if (schema.default !== undefined) {
-        return schema.default;
+        return cache(schema, schema.default);
     }
     // enum: [ 'available', 'pending', 'sold' ]
     if (Array.isArray(schema.enum) && schema.enum.length > 0) {
-        return schema.enum[0];
+        return cache(schema, schema.enum[0]);
     }
     // Check if the property is required
     const isObjectOrArray = schema.type === 'object' ||
@@ -144,14 +159,14 @@ const getExampleFromSchema = (schema, options, level = 0, parentSchema, name) =>
                 .map((item) => getExampleFromSchema(item, options, level + 1, schema))
                 .filter((item) => item !== undefined));
         }
-        return response;
+        return cache(schema, response);
     }
     // Array
     if (schema.type === 'array' || schema.items !== undefined) {
         const itemsXmlTagName = schema?.items?.xml?.name;
         const wrapItems = !!(options?.xml && schema.xml?.wrapped && itemsXmlTagName);
         if (schema.example !== undefined) {
-            return wrapItems ? { [itemsXmlTagName]: schema.example } : schema.example;
+            return cache(schema, wrapItems ? { [itemsXmlTagName]: schema.example } : schema.example);
         }
         // Check whether the array has a anyOf, oneOf, or allOf rule
         if (schema.items) {
@@ -171,9 +186,9 @@ const getExampleFromSchema = (schema, options, level = 0, parentSchema, name) =>
                 const exampleFromRule = schemas
                     .map((item) => getExampleFromSchema(item, options, level + 1, schema))
                     .filter((item) => item !== undefined);
-                return wrapItems
+                return cache(schema, wrapItems
                     ? [{ [itemsXmlTagName]: exampleFromRule }]
-                    : exampleFromRule;
+                    : exampleFromRule);
             }
         }
         if (schema.items?.type) {
@@ -194,7 +209,7 @@ const getExampleFromSchema = (schema, options, level = 0, parentSchema, name) =>
         array: [],
     };
     if (schema.type !== undefined && exampleValues[schema.type] !== undefined) {
-        return exampleValues[schema.type];
+        return cache(schema, exampleValues[schema.type]);
     }
     const discriminateSchema = schema.oneOf || schema.anyOf;
     // Check if property has the `oneOf` | `anyOf` key
@@ -222,7 +237,7 @@ const getExampleFromSchema = (schema, options, level = 0, parentSchema, name) =>
                         ? [...(example ?? {}), ...newExample]
                         : newExample;
         });
-        return example;
+        return cache(schema, example);
     }
     // Check if schema is a union type
     if (Array.isArray(schema.type)) {
@@ -233,7 +248,7 @@ const getExampleFromSchema = (schema, options, level = 0, parentSchema, name) =>
         // Return an example for the first type in the union
         const exampleValue = exampleValues[schema.type[0]];
         if (exampleValue !== undefined) {
-            return exampleValue;
+            return cache(schema, exampleValue);
         }
     }
     // Warn if the type is unknown …

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.53",
+  "version": "0.2.55",
   "engines": {
     "node": ">=18"
   },
@@ -25,59 +25,73 @@
   "exports": {
     "./transforms": {
       "import": "./dist/transforms/index.js",
-      "types": "./dist/transforms/index.d.ts"
+      "types": "./dist/transforms/index.d.ts",
+      "default": "./dist/transforms/index.js"
     },
     "./spec-getters": {
       "import": "./dist/spec-getters/index.js",
-      "types": "./dist/spec-getters/index.d.ts"
+      "types": "./dist/spec-getters/index.d.ts",
+      "default": "./dist/spec-getters/index.js"
     },
     "./migrations": {
       "import": "./dist/migrations/index.js",
-      "types": "./dist/migrations/index.d.ts"
+      "types": "./dist/migrations/index.d.ts",
+      "default": "./dist/migrations/index.js"
     },
     "./migrations/v-2.1.0": {
       "import": "./dist/migrations/v-2.1.0/index.js",
-      "types": "./dist/migrations/v-2.1.0/index.d.ts"
+      "types": "./dist/migrations/v-2.1.0/index.d.ts",
+      "default": "./dist/migrations/v-2.1.0/index.js"
     },
     "./migrations/v-0.0.0": {
       "import": "./dist/migrations/v-0.0.0/index.js",
-      "types": "./dist/migrations/v-0.0.0/index.d.ts"
+      "types": "./dist/migrations/v-0.0.0/index.d.ts",
+      "default": "./dist/migrations/v-0.0.0/index.js"
     },
     "./helpers": {
       "import": "./dist/helpers/index.js",
-      "types": "./dist/helpers/index.d.ts"
+      "types": "./dist/helpers/index.d.ts",
+      "default": "./dist/helpers/index.js"
     },
     "./entities": {
       "import": "./dist/entities/index.js",
-      "types": "./dist/entities/index.d.ts"
+      "types": "./dist/entities/index.d.ts",
+      "default": "./dist/entities/index.js"
     },
     "./entities/workspace": {
       "import": "./dist/entities/workspace/index.js",
-      "types": "./dist/entities/workspace/index.d.ts"
+      "types": "./dist/entities/workspace/index.d.ts",
+      "default": "./dist/entities/workspace/index.js"
     },
     "./entities/spec": {
       "import": "./dist/entities/spec/index.js",
-      "types": "./dist/entities/spec/index.d.ts"
+      "types": "./dist/entities/spec/index.d.ts",
+      "default": "./dist/entities/spec/index.js"
     },
     "./entities/shared": {
       "import": "./dist/entities/shared/index.js",
-      "types": "./dist/entities/shared/index.d.ts"
+      "types": "./dist/entities/shared/index.d.ts",
+      "default": "./dist/entities/shared/index.js"
     },
     "./entities/hotkeys": {
       "import": "./dist/entities/hotkeys/index.js",
-      "types": "./dist/entities/hotkeys/index.d.ts"
+      "types": "./dist/entities/hotkeys/index.d.ts",
+      "default": "./dist/entities/hotkeys/index.js"
     },
     "./entities/environment": {
       "import": "./dist/entities/environment/index.js",
-      "types": "./dist/entities/environment/index.d.ts"
+      "types": "./dist/entities/environment/index.d.ts",
+      "default": "./dist/entities/environment/index.js"
     },
     "./entities/cookie": {
       "import": "./dist/entities/cookie/index.js",
-      "types": "./dist/entities/cookie/index.d.ts"
+      "types": "./dist/entities/cookie/index.d.ts",
+      "default": "./dist/entities/cookie/index.js"
     },
     "./diff": {
       "import": "./dist/diff/index.js",
-      "types": "./dist/diff/index.d.ts"
+      "types": "./dist/diff/index.d.ts",
+      "default": "./dist/diff/index.js"
     }
   },
   "files": [
@@ -92,10 +106,10 @@
     "nanoid": "^5.0.7",
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
-    "@scalar/object-utils": "1.1.9",
-    "@scalar/openapi-types": "0.1.1",
-    "@scalar/types": "0.0.13",
-    "@scalar/themes": "0.9.35"
+    "@scalar/object-utils": "1.1.10",
+    "@scalar/openapi-types": "0.1.2",
+    "@scalar/themes": "0.9.36",
+    "@scalar/types": "0.0.14"
   },
   "devDependencies": {
     "rollup": "^4.16.4",
@@ -103,9 +117,9 @@
     "vite": "^5.2.10",
     "vitest": "^1.6.0",
     "zod-to-ts": "^1.2.0",
-    "@scalar/build-tooling": "0.1.10",
-    "@scalar/openapi-parser": "0.8.5",
-    "@scalar/openapi-types": "0.1.1"
+    "@scalar/build-tooling": "0.1.11",
+    "@scalar/openapi-types": "0.1.2",
+    "@scalar/openapi-parser": "0.8.6"
   },
   "scripts": {
     "build": "scalar-build-rollup",