@scalar/oas-utils 0.2.44 → 0.2.46

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @scalar/oas-utils
 
+## 0.2.46
+
+### Patch Changes
+
+- 2b75354: fix: null example bug
+- 437d54d: fix: runtime null error prettyprint
+
+## 0.2.45
+
+### Patch Changes
+
+- ddeaada: fix: adds path regex helper
+- 71278e1: fix(api-client): add back content header
+
 ## 0.2.44
 
 ### Patch Changes

package/dist/entities/spec/request-examples.d.ts

@@ -57,6 +57,7 @@ export type RequestExampleParameter = z.infer<typeof requestExampleParametersSch
  * TODO: This list may not be comprehensive enough
  */
 export declare const exampleRequestBodyEncoding: readonly ["json", "text", "html", "javascript", "xml", "yaml", "edn"];
+export type BodyEncoding = (typeof exampleRequestBodyEncoding)[number];
 export declare const exampleRequestBodySchema: z.ZodObject<{
     raw: z.ZodOptional<z.ZodObject<{
         encoding: z.ZodDefault<z.ZodEnum<["json", "text", "html", "javascript", "xml", "yaml", "edn"]>>;

package/dist/entities/spec/request-examples.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"request-examples.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/request-examples.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC,eAAO,MAAM,8BAA8B;;;;;;IAMzC,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAUlF,CAAA;AAEF,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,uEAQ7B,CAAA;AAEV,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;YAhCnC,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmDlF,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAEzE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;gBAvD/B,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuElF,CAAA;AAEF,qDAAqD;AACrD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAKxE,6DAA6D;AAC7D,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,gBAAgB;;;;;;;;;;;;;;;EAoB1D;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,GACd,cAAc,CAiFhB"}
+{"version":3,"file":"request-examples.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/request-examples.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC,eAAO,MAAM,8BAA8B;;;;;;IAMzC,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAUlF,CAAA;AAEF,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,uEAQ7B,CAAA;AACV,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAA;AAEtE,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;YAjCnC,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoDlF,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAEzE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;gBAvD/B,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuElF,CAAA;AAEF,qDAAqD;AACrD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAKxE,6DAA6D;AAC7D,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,gBAAgB;;;;;;;;;;;;;;;EA8B1D;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,GACd,cAAc,CAyFhB"}

package/dist/entities/spec/request-examples.js

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { schemaModel } from '../../helpers/schema-model.js';
 import { getRequestBodyFromOperation } from '../../spec-getters/getRequestBodyFromOperation.js';
 import { getServerVariableExamples } from '../../spec-getters/getServerVariableExamples.js';
 import { nanoidSchema } from '../shared/utility.js';
@@ -83,7 +84,8 @@ function createParamInstance(param) {
      * - Need to handle unions/array values for schema
      */
     const value = String(schema?.default ?? schema?.examples?.[0] ?? '');
-    return requestExampleParametersSchema.parse({
+    // safe parse the example
+    const example = schemaModel({
         ...schema,
         key: param.name,
         value,
@@ -91,7 +93,13 @@ function createParamInstance(param) {
         required: param.required,
         /** Initialized all required properties to enabled */
         enabled: !!param.required,
-    });
+    }, requestExampleParametersSchema, false);
+    if (!example) {
+        console.warn(`Example at ${param.name} is invalid.`);
+        return requestExampleParametersSchema.parse({});
+    }
+    else
+        return example;
 }
 /**
  * Create new request example from a request
@@ -155,14 +163,20 @@ function createExampleFromRequest(request, name, server) {
         }
     }
     const serverVariables = server ? getServerVariableExamples(server) : {};
-    const example = requestExampleSchema.parse({
+    // safe parse the example
+    const example = schemaModel({
         requestUid: request.uid,
         parameters,
         name,
         body,
         serverVariables,
-    });
-    return example;
+    }, requestExampleSchema, false);
+    if (!example) {
+        console.warn(`Example at ${request.uid} is invalid.`);
+        return requestExampleSchema.parse({});
+    }
+    else
+        return example;
 }
 
 export { createExampleFromRequest, createParamInstance, exampleRequestBodyEncoding, exampleRequestBodySchema, requestExampleParametersSchema, requestExampleSchema };

package/dist/helpers/index.js

@@ -17,4 +17,4 @@ export { schemaModel } from './schema-model.js';
 export { defaultStateFactory, ssrState } from './ssrState.js';
 export { camelToTitleWords, capitalize } from './string.js';
 export { isValidUrl } from './isValidUrl.js';
-export { variableRegex } from './regexHelpers.js';
+export { pathRegex, variableRegex } from './regexHelpers.js';

package/dist/helpers/prettyPrintJson.js

@@ -21,7 +21,7 @@ const prettyPrintJson = (value) => {
             return replaceCircularDependencies(value);
         }
     }
-    return value.toString();
+    return value?.toString() ?? '';
 };
 /**
  * JSON.stringify, but with circular dependencies replaced with '[Circular]'

package/dist/helpers/regexHelpers.d.ts

@@ -1,2 +1,3 @@
 export declare const variableRegex: RegExp;
+export declare const pathRegex: RegExp;
 //# sourceMappingURL=regexHelpers.d.ts.map

package/dist/helpers/regexHelpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"regexHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/regexHelpers.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,QAA+B,CAAA"}
+{"version":3,"file":"regexHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/regexHelpers.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,QAA+B,CAAA;AACzD,eAAO,MAAM,SAAS,QAA2B,CAAA"}

package/dist/helpers/regexHelpers.js

@@ -1,3 +1,4 @@
 const variableRegex = /{{((?:[^{}]|{[^{}]*})*)}}/g;
+const pathRegex = /(?<!{){([^{}]+)}(?!})/g;
 
-export { variableRegex };
+export { pathRegex, variableRegex };

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.44",
+  "version": "0.2.46",
   "engines": {
     "node": ">=18"
   },
@@ -93,9 +93,9 @@
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
     "@scalar/object-utils": "1.1.8",
-    "@scalar/themes": "0.9.30",
+    "@scalar/openapi-types": "0.1.1",
     "@scalar/types": "0.0.9",
-    "@scalar/openapi-types": "0.1.1"
+    "@scalar/themes": "0.9.30"
   },
   "devDependencies": {
     "rollup": "^4.16.4",
@@ -103,8 +103,8 @@
     "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.3",
+    "@scalar/build-tooling": "0.1.10",
     "@scalar/openapi-types": "0.1.1"
   },
   "scripts": {