@scalar/workspace-store 0.68.4 → 0.68.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scalar/workspace-store
 
+## 0.68.5
+
+### Patch Changes
+
+- [#10677](https://github.com/scalar/scalar/pull/10677): Generate serialized JSON examples from `contentSchema` instead of falling back to `null`, including JSON media type parameters, structured JSON suffixes, and string type arrays.
+
 ## 0.68.4
 
 ### Patch Changes

package/dist/request-example/builder/helpers/get-example-from-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-example-from-schema.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/helpers/get-example-from-schema.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,YAAY,EAAqD,MAAM,uBAAuB,CAAA;AAG5G,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAE1E,OAAO,EAAE,kBAAkB,EAA0B,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAwZ9G,gGAAgG;AAChG,eAAO,MAAM,wBAAwB,GACnC,QAAQ,YAAY,EACpB,YAAY,MAAM,EAAE,EACpB,UAAU,2BAA2B,EACrC,mBAAiB,EACjB,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC9B,YAAY,GAAG,SAoBjB,CAAA;AAiaD,sEAAsE;AACtE,MAAM,MAAM,2BAA2B,GAAG;IACxC,2EAA2E;IAC3E,CAAC,kBAAkB,CAAC,CAAC,EAAE,sBAAsB,CAAA;IAC7C,mFAAmF;IACnF,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kFAAkF;IAClF,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,qDAAqD;IACrD,8BAA8B,CAAC,EAAE,OAAO,CAAA;IACxC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC9C,CAAA;AAyPD;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,yBAAyB,GAC7B,QAAQ,YAAY,EACpB,UAAU,2BAA2B,EACrC,iEAOG,OAAO,CAAC;IACT,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,YAAY,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;IACrB,6EAA6E;IAC7E,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,qGAAqG;IACrG,YAAY,EAAE,YAAY,CAAA;CAC3B,CAAM,KACN,OAgPF,CAAA;AAoBD,gGAAgG;AAChG,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,YAAY,EACpB,UAAU,2BAA2B,EACrC,UAAS,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAC,CAAC,CAAM,KAC5D,OA2BF,CAAA"}
+{"version":3,"file":"get-example-from-schema.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/helpers/get-example-from-schema.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,YAAY,EAAqD,MAAM,uBAAuB,CAAA;AAG5G,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAE1E,OAAO,EAAE,kBAAkB,EAA0B,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAwZ9G,gGAAgG;AAChG,eAAO,MAAM,wBAAwB,GACnC,QAAQ,YAAY,EACpB,YAAY,MAAM,EAAE,EACpB,UAAU,2BAA2B,EACrC,mBAAiB,EACjB,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC9B,YAAY,GAAG,SAoBjB,CAAA;AAiaD,sEAAsE;AACtE,MAAM,MAAM,2BAA2B,GAAG;IACxC,2EAA2E;IAC3E,CAAC,kBAAkB,CAAC,CAAC,EAAE,sBAAsB,CAAA;IAC7C,mFAAmF;IACnF,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kFAAkF;IAClF,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,qDAAqD;IACrD,8BAA8B,CAAC,EAAE,OAAO,CAAA;IACxC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC9C,CAAA;AA+PD;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,yBAAyB,GAC7B,QAAQ,YAAY,EACpB,UAAU,2BAA2B,EACrC,iEAOG,OAAO,CAAC;IACT,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,YAAY,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;IACrB,6EAA6E;IAC7E,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,qGAAqG;IACrG,YAAY,EAAE,YAAY,CAAA;CAC3B,CAAM,KACN,OA8QF,CAAA;AAoBD,gGAAgG;AAChG,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,YAAY,EACpB,UAAU,2BAA2B,EACrC,UAAS,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAC,CAAC,CAAM,KAC5D,OA2BF,CAAA"}

package/dist/request-example/builder/helpers/get-example-from-schema.js

@@ -1,4 +1,5 @@
 import { isDefined } from '@scalar/helpers/array/is-defined';
+import { isJsonMediaType } from '@scalar/helpers/http/is-json-media-type';
 import { escapeJsonPointer } from '@scalar/helpers/json/escape-json-pointer';
 import { isDynamicRef, pushDynamicScope, resolveDynamicRef } from '../../../helpers/dynamic-ref.js';
 import { unpackProxyObject } from '../../../helpers/unpack-proxy.js';
@@ -881,6 +882,13 @@ const getMaxDepthValue = (schema, options, schemaPath, seen = new Set()) => {
     truncated = true;
     return MAX_DEPTH_EXCEEDED;
 };
+const hasUnencodedJsonContent = (schema) => {
+    if (!('contentSchema' in schema) || !isJsonMediaType(schema.contentMediaType))
+        return false;
+    if ('contentEncoding' in schema)
+        return false;
+    return !('type' in schema) || getDeclaredTypes(schema).includes('string');
+};
 /**
  * Generate an example value from a given OpenAPI SchemaObject.
  *
@@ -1005,7 +1013,13 @@ const generateExampleFromSchema = (schema, options, { level = 0, parentSchema, n
     if (selectedComposition && selectedVariant) {
         const rootType = 'type' in _schema ? _schema.type : undefined;
         const variantType = 'type' in selectedVariant ? selectedVariant.type : undefined;
-        const selectedType = variantType ?? rootType ?? ('items' in _schema && !('properties' in _schema) ? 'array' : undefined);
+        const selectedType = variantType ??
+            rootType ??
+            (hasUnencodedJsonContent(_schema)
+                ? 'string'
+                : 'items' in _schema && !('properties' in _schema)
+                    ? 'array'
+                    : undefined);
         if (selectedType !== undefined && selectedType !== 'object') {
             const { oneOf: _oneOf, anyOf: _anyOf, ...base } = _schema;
             const selectedSchema = { ...base, ...selectedVariant };
@@ -1028,6 +1042,25 @@ const generateExampleFromSchema = (schema, options, { level = 0, parentSchema, n
             return cache(_schema, result, cacheKey, skipCache);
         }
     }
+    if (hasUnencodedJsonContent(_schema)) {
+        const contentSchema = resolve.schema(_schema.contentSchema);
+        if (contentSchema) {
+            // JSON content preserves strings and property names regardless of the enclosing wire format.
+            const content = getExampleFromSchema(contentSchema, { ...options, xml: false, binaryAsFile: false }, {
+                level: level + 1,
+                // The decoded value inherits the field requirement, not the string wrapper as a parent.
+                parentSchema,
+                name,
+                schemaPath: [...schemaPath, 'contentSchema'],
+                seen,
+                dynamicScope: childScope,
+            });
+            if (content !== undefined) {
+                seen.delete(targetValue);
+                return cache(_schema, JSON.stringify(content), cacheKey, skipCache);
+            }
+        }
+    }
     // Handle object types - check for properties to identify objects
     if ('properties' in _schema || ('type' in _schema && _schema.type === 'object')) {
         const result = handleObjectSchema(_schema, options, level, seen, cacheKey, schemaPath, dynamicScope);

package/package.json

@@ -16,7 +16,7 @@
     "openapi",
     "scalar"
   ],
-  "version": "0.68.4",
+  "version": "0.68.5",
   "engines": {
     "node": ">=22"
   },
@@ -155,10 +155,10 @@
   "dependencies": {
     "@scalar/asyncapi-upgrader": "0.1.18",
     "@scalar/helpers": "0.16.4",
-    "@scalar/json-magic": "0.16.0",
+    "@scalar/json-magic": "0.16.1",
     "@scalar/openapi-upgrader": "0.4.5",
     "@scalar/schemas": "0.14.0",
-    "@scalar/snippetz": "0.10.9",
+    "@scalar/snippetz": "0.10.10",
     "@scalar/typebox": "0.1.3",
     "@scalar/types": "0.24.0",
     "@scalar/validation": "0.6.7",