@scalar/oas-utils 0.2.124 → 0.2.126

package/dist/spec-getters/get-example-from-schema.js

@@ -1,5 +1,7 @@
 /** Hard limit for rendering circular references */
 const MAX_LEVELS_DEEP = 5;
+/** Sets the max number of properties after the third level to prevent exponential horizontal growth */
+const MAX_PROPERTIES = 10;
 const genericExampleValues = {
     // 'date-time': '1970-01-01T00:00:00Z',
     'date-time': new Date().toISOString(),
@@ -118,15 +120,22 @@ const getExampleFromSchema = (schema, options, level = 0, parentSchema, name) =>
     // Object
     if (schema.type === 'object' || schema.properties !== undefined) {
         const response = {};
+        let propertyCount = 0;
         // Regular properties
         if (schema.properties !== undefined) {
             for (const propertyName in schema.properties) {
                 if (Object.prototype.hasOwnProperty.call(schema.properties, propertyName)) {
+                    // Only apply property limit for nested levels (level > 0)
+                    if (level > 3 && propertyCount >= MAX_PROPERTIES) {
+                        response['...'] = '[Additional Properties Truncated]';
+                        break;
+                    }
                     const property = schema.properties[propertyName];
                     const propertyXmlTagName = options?.xml ? property.xml?.name : undefined;
-                    response[propertyXmlTagName ?? propertyName] = getExampleFromSchema(property, options, level + 1, schema, propertyName);
-                    if (typeof response[propertyXmlTagName ?? propertyName] === 'undefined') {
-                        delete response[propertyXmlTagName ?? propertyName];
+                    const value = getExampleFromSchema(property, options, level + 1, schema, propertyName);
+                    if (typeof value !== 'undefined') {
+                        response[propertyXmlTagName ?? propertyName] = value;
+                        propertyCount++;
                     }
                 }
             }

package/dist/transforms/import-spec.d.ts

@@ -5,9 +5,9 @@ import type { SelectedSecuritySchemeUids } from '../entities/shared/utility.ts';
 import { type Collection, type CollectionPayload } from '../entities/spec/collection.ts';
 import { type RequestExample } from '../entities/spec/request-examples.ts';
 import { type Request } from '../entities/spec/requests.ts';
-import { type SecurityScheme } from '../entities/spec/security.ts';
 import { type Server } from '../entities/spec/server.ts';
 import { type Tag } from '../entities/spec/spec-objects.ts';
+import { type SecurityScheme } from '@scalar/types/entities';
 /** Takes a string or object and parses it into an openapi spec compliant schema */
 export declare const parseSchema: (spec: string | UnknownObject, { shouldLoad }?: {
     shouldLoad?: boolean | undefined;

package/dist/transforms/import-spec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAE5E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAA;AAC9E,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,iBAAiB,EAAoB,MAAM,+BAA+B,CAAA;AAEzG,OAAO,EAAE,KAAK,cAAc,EAA4B,MAAM,qCAAqC,CAAA;AACnG,OAAO,EAAE,KAAK,OAAO,EAAsC,MAAM,6BAA6B,CAAA;AAC9F,OAAO,EAEL,KAAK,cAAc,EAGpB,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,2BAA2B,CAAA;AACrE,OAAO,EAAE,KAAK,GAAG,EAAa,MAAM,iCAAiC,CAAA;AAMrE,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAAgB,MAAM,GAAG,aAAa;;;IAoC1D;;;OAGG;YAC8C,WAAW,CAAC,QAAQ;;EAGxE,CAAA;AAED,sDAAsD;AACtD,eAAO,MAAM,6BAA6B,yBAClB,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,0BACnB,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,iCAC1B,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,KACvD,0BAaF,CAAA;AAED,iCAAiC;AACjC,eAAO,MAAM,UAAU,SAAU,MAAM,KAA2B,UAAU,CAAC,KAAK,CAAC,CAAA;AAEnF,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,iBAAiB,EAAE,aAAa,GAAG,WAAW,CAAC,GAC1F,IAAI,CAAC,yBAAyB,EAAE,gBAAgB,GAAG,eAAe,GAAG,SAAS,GAAG,MAAM,CAAC,GAAG;IACzF,mFAAmF;IACnF,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,iBAAiB,EAC1B,qBAA6B,EAC7B,IAAI,EACJ,UAAU,EACV,SAAiB,GAClB,GAAE,yBAA8B,GAChC,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAA;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,eAAe,EAAE,cAAc,EAAE,CAAA;CAClC,GACD;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,cAAc,EAAE,MAAM,EAAE,CAAC;IAAC,UAAU,EAAE,SAAS,CAAA;CAAE,CACnE,CAyWA;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,WAAW,CAAC,YAAY,EAAE,GAAG,SAAS,EAC/C,EAAE,aAAa,EAAE,GAAE,IAAI,CAAC,yBAAyB,EAAE,eAAe,CAAM,GACvE,MAAM,EAAE,CA0CV"}
+{"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAE5E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAA;AAC9E,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,iBAAiB,EAAoB,MAAM,+BAA+B,CAAA;AAEzG,OAAO,EAAE,KAAK,cAAc,EAA4B,MAAM,qCAAqC,CAAA;AACnG,OAAO,EAAE,KAAK,OAAO,EAAsC,MAAM,6BAA6B,CAAA;AAC9F,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,2BAA2B,CAAA;AACrE,OAAO,EAAE,KAAK,GAAG,EAAa,MAAM,iCAAiC,CAAA;AAKrE,OAAO,EAEL,KAAK,cAAc,EAGpB,MAAM,wBAAwB,CAAA;AAE/B,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAAgB,MAAM,GAAG,aAAa;;;IAoC1D;;;OAGG;YAC8C,WAAW,CAAC,QAAQ;;EAGxE,CAAA;AAED,sDAAsD;AACtD,eAAO,MAAM,6BAA6B,yBAClB,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,0BACnB,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,iCAC1B,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,KACvD,0BAaF,CAAA;AAED,iCAAiC;AACjC,eAAO,MAAM,UAAU,SAAU,MAAM,KAA2B,UAAU,CAAC,KAAK,CAAC,CAAA;AAEnF,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,iBAAiB,EAAE,aAAa,GAAG,WAAW,CAAC,GAC1F,IAAI,CAAC,yBAAyB,EAAE,gBAAgB,GAAG,eAAe,GAAG,SAAS,GAAG,MAAM,CAAC,GAAG;IACzF,mFAAmF;IACnF,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,iBAAiB,EAC1B,qBAA6B,EAC7B,IAAI,EACJ,UAAU,EACV,SAAiB,GAClB,GAAE,yBAA8B,GAChC,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAA;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,eAAe,EAAE,cAAc,EAAE,CAAA;CAClC,GACD;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,cAAc,EAAE,MAAM,EAAE,CAAC;IAAC,UAAU,EAAE,SAAS,CAAA;CAAE,CACnE,CAyWA;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,WAAW,CAAC,YAAY,EAAE,GAAG,SAAS,EAC/C,EAAE,aAAa,EAAE,GAAE,IAAI,CAAC,yBAAyB,EAAE,eAAe,CAAM,GACvE,MAAM,EAAE,CA0CV"}

package/dist/transforms/import-spec.js

@@ -3,13 +3,13 @@ import { load, upgrade, dereference } from '@scalar/openapi-parser';
 import { collectionSchema } from '../entities/spec/collection.js';
 import { createExampleFromRequest } from '../entities/spec/request-examples.js';
 import { requestSchema } from '../entities/spec/requests.js';
-import { securitySchemeSchema } from '../entities/spec/security.js';
 import { serverSchema } from '../entities/spec/server.js';
 import { tagSchema } from '../entities/spec/spec-objects.js';
 import { isHttpMethod } from '../helpers/http-methods.js';
 import { isDefined } from '../helpers/is-defined.js';
 import { combineUrlAndPath } from '../helpers/merge-urls.js';
 import { schemaModel } from '../helpers/schema-model.js';
+import { securitySchemeSchema } from '@scalar/types/entities';
 
 /** Takes a string or object and parses it into an openapi spec compliant schema */
 const parseSchema = async (spec, { shouldLoad = true } = {}) => {

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.124",
+  "version": "0.2.126",
   "engines": {
     "node": ">=18"
   },
@@ -88,9 +88,9 @@
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
     "@scalar/object-utils": "1.1.13",
-    "@scalar/openapi-types": "0.1.9",
-    "@scalar/themes": "0.9.82",
-    "@scalar/types": "0.1.4"
+    "@scalar/themes": "0.9.84",
+    "@scalar/openapi-types": "0.2.0",
+    "@scalar/types": "0.1.6"
   },
   "devDependencies": {
     "@types/node": "^20.17.10",
@@ -99,8 +99,8 @@
     "vitest": "^1.6.0",
     "zod-to-ts": "github:amritk/zod-to-ts#build",
     "@scalar/build-tooling": "0.1.17",
-    "@scalar/openapi-parser": "0.10.12",
-    "@scalar/openapi-types": "0.1.9"
+    "@scalar/openapi-parser": "0.10.14",
+    "@scalar/openapi-types": "0.2.0"
   },
   "scripts": {
     "build": "scalar-build-rollup",