@scalar/oas-utils 0.2.2 → 0.2.4

package/dist/entities/workspace/security/security-schemes.js

@@ -0,0 +1,146 @@
+import { z } from 'zod';
+
+/** The uid here is actually the name key, called uid to re-use our mutators */
+const uid = z.string().optional().default('default');
+/* A description for security scheme. CommonMark syntax MAY be used for rich text representation. */
+const description = z.string().optional();
+/** A generic string value used for filling in fields  */
+const value = z.string().optional().default('');
+const securitySchemeApiKey = z.object({
+    type: z.literal('apiKey'),
+    uid,
+    description,
+    /** REQUIRED. The name of the header, query or cookie parameter to be used. */
+    name: z.string().optional().default('default'),
+    /** REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie". */
+    in: z.enum(['query', 'header', 'cookie']).optional().default('header'),
+    value,
+});
+const securitySchemeHttp = z.object({
+    type: z.literal('http'),
+    uid,
+    description,
+    /**
+     * REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in
+     * [RFC7235]. The values used SHOULD be registered in the IANA Authentication Scheme registry.
+     */
+    scheme: z.enum(['basic', 'bearer']).optional().default('basic'),
+    /**
+     * A hint to the client to identify how the bearer token is formatted.
+     * Bearer tokens are usually generated by an authorization server, so
+     * this information is primarily for documentation purposes.
+     */
+    bearerFormat: z
+        .union([z.literal('JWT'), z.string()])
+        .optional()
+        .default('JWT'),
+    value,
+    secondValue: value,
+});
+/**
+ * REQUIRED. The authorization URL to be used for this flow. This MUST be in
+ * the form of a URL. The OAuth2 standard requires the use of TLS.
+ */
+const authorizationUrl = z.string().optional().default('https://scalar.com');
+/** REQUIRED. The token URL to be used for this flow. This MUST be in the
+ * form of a URL. The OAuth2 standard requires the use of TLS.
+ */
+const tokenUrl = z.string().optional().default('https://scalar.com');
+/** The URL to be used for obtaining refresh tokens. This MUST be in the form of a
+ * URL. The OAuth2 standard requires the use of TLS.
+ */
+const refreshUrl = z.string().optional();
+/**
+ * REQUIRED. The available scopes for the OAuth2 security scheme. A map
+ * between the scope name and a short description for it. The map MAY be empty.
+ */
+const scopes = z
+    .union([
+    z.map(z.string(), z.string().optional()),
+    z.record(z.string(), z.string().optional()),
+    z.object({}),
+])
+    .optional();
+/** User selected scopes per flow */
+const selectedScopes = z.array(z.string()).optional().default([]);
+const oauthFlowSchema = z
+    .object({
+    /** Configuration for the OAuth Implicit flow */
+    implicit: z
+        .object({
+        authorizationUrl,
+        refreshUrl,
+        scopes,
+        selectedScopes,
+        token: value,
+    })
+        .optional(),
+    /** Configuration for the OAuth Resource Owner Password flow */
+    password: z
+        .object({
+        tokenUrl,
+        refreshUrl,
+        scopes,
+        username: value,
+        password: value,
+        selectedScopes,
+        token: value,
+    })
+        .optional(),
+    /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
+    clientCredentials: z
+        .object({
+        tokenUrl,
+        refreshUrl,
+        scopes,
+        clientSecret: value,
+        selectedScopes,
+        token: value,
+    })
+        .optional(),
+    /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0.*/
+    authorizationCode: z
+        .object({
+        authorizationUrl,
+        tokenUrl,
+        refreshUrl,
+        scopes,
+        clientSecret: value,
+        selectedScopes,
+        token: value,
+    })
+        .optional(),
+})
+    .optional()
+    .default({
+    implicit: {},
+});
+const securitySchemeOauth2 = z.object({
+    type: z.literal('oauth2'),
+    uid,
+    description,
+    /** REQUIRED. An object containing configuration information for the flow types supported. */
+    flows: oauthFlowSchema,
+    clientId: value,
+    redirectUri: z.string().url().optional().default(''),
+});
+const securitySchemeOpenId = z.object({
+    type: z.literal('openIdConnect'),
+    uid,
+    description,
+    /**
+     * REQUIRED. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the
+     * form of a URL. The OpenID Connect standard requires the use of TLS.
+     */
+    openIdConnectUrl: z.string().url().optional().default('https://scalar.com'),
+});
+const securityScheme = z.union([
+    securitySchemeApiKey,
+    securitySchemeHttp,
+    securitySchemeOauth2,
+    securitySchemeOpenId,
+]);
+/** Create Security Scheme with defaults */
+const createSecurityScheme = (payload) => securityScheme.parse(payload);
+
+export { createSecurityScheme };

package/dist/entities/workspace/server/server.d.ts

@@ -35,13 +35,13 @@ declare const serverSchema: z.ZodObject<{
         enum?: string[] | undefined;
     }, {
         default?: string | undefined;
-        description?: string | undefined;
         uid?: string | undefined;
+        description?: string | undefined;
         enum?: string[] | undefined;
     }>>>>;
 }, "strip", z.ZodTypeAny, {
-    url: string;
     uid: string;
+    url: string;
     description?: string | undefined;
     variables?: Record<string, {
         default: string;
@@ -50,13 +50,13 @@ declare const serverSchema: z.ZodObject<{
         enum?: string[] | undefined;
     }> | null | undefined;
 }, {
-    url?: string | undefined;
-    description?: string | undefined;
     uid?: string | undefined;
+    description?: string | undefined;
+    url?: string | undefined;
     variables?: Record<string, {
         default?: string | undefined;
-        description?: string | undefined;
         uid?: string | undefined;
+        description?: string | undefined;
         enum?: string[] | undefined;
     }> | null | undefined;
 }>;
@@ -70,8 +70,8 @@ export type Server = z.infer<typeof serverSchema>;
 export type ServerPayload = z.input<typeof serverSchema>;
 /** Create server helper */
 export declare const createServer: (payload: ServerPayload) => {
-    url: string;
     uid: string;
+    url: string;
     description?: string | undefined;
     variables?: Record<string, {
         default: string;

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

@@ -236,7 +236,7 @@ declare const requestExampleSchema: z.ZodObject<{
             file?: File | undefined;
             refUid?: string | undefined;
         }[];
-        cookies: {
+        query: {
             value: string;
             key: string;
             enabled: boolean;
@@ -244,7 +244,7 @@ declare const requestExampleSchema: z.ZodObject<{
             file?: File | undefined;
             refUid?: string | undefined;
         }[];
-        headers: {
+        cookies: {
             value: string;
             key: string;
             enabled: boolean;
@@ -252,7 +252,7 @@ declare const requestExampleSchema: z.ZodObject<{
             file?: File | undefined;
             refUid?: string | undefined;
         }[];
-        query: {
+        headers: {
             value: string;
             key: string;
             enabled: boolean;
@@ -269,7 +269,7 @@ declare const requestExampleSchema: z.ZodObject<{
             file?: File | undefined;
             refUid?: string | undefined;
         }[] | undefined;
-        cookies?: {
+        query?: {
             value?: string | number | undefined;
             description?: string | undefined;
             key?: string | undefined;
@@ -277,7 +277,7 @@ declare const requestExampleSchema: z.ZodObject<{
             file?: File | undefined;
             refUid?: string | undefined;
         }[] | undefined;
-        headers?: {
+        cookies?: {
             value?: string | number | undefined;
             description?: string | undefined;
             key?: string | undefined;
@@ -285,7 +285,7 @@ declare const requestExampleSchema: z.ZodObject<{
             file?: File | undefined;
             refUid?: string | undefined;
         }[] | undefined;
-        query?: {
+        headers?: {
             value?: string | number | undefined;
             description?: string | undefined;
             key?: string | undefined;
@@ -296,8 +296,8 @@ declare const requestExampleSchema: z.ZodObject<{
     }>>>;
     auth: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodAny>>;
 }, "strip", z.ZodTypeAny, {
-    name: string;
     uid: string;
+    name: string;
     parameters: {
         path: {
             value: string;
@@ -307,7 +307,7 @@ declare const requestExampleSchema: z.ZodObject<{
             file?: File | undefined;
             refUid?: string | undefined;
         }[];
-        cookies: {
+        query: {
             value: string;
             key: string;
             enabled: boolean;
@@ -315,7 +315,7 @@ declare const requestExampleSchema: z.ZodObject<{
             file?: File | undefined;
             refUid?: string | undefined;
         }[];
-        headers: {
+        cookies: {
             value: string;
             key: string;
             enabled: boolean;
@@ -323,7 +323,7 @@ declare const requestExampleSchema: z.ZodObject<{
             file?: File | undefined;
             refUid?: string | undefined;
         }[];
-        query: {
+        headers: {
             value: string;
             key: string;
             enabled: boolean;
@@ -355,8 +355,8 @@ declare const requestExampleSchema: z.ZodObject<{
     auth: Record<string, any>;
 }, {
     requestUid: string;
-    name?: string | undefined;
     uid?: string | undefined;
+    name?: string | undefined;
     parameters?: {
         path?: {
             value?: string | number | undefined;
@@ -366,7 +366,7 @@ declare const requestExampleSchema: z.ZodObject<{
             file?: File | undefined;
             refUid?: string | undefined;
         }[] | undefined;
-        cookies?: {
+        query?: {
             value?: string | number | undefined;
             description?: string | undefined;
             key?: string | undefined;
@@ -374,7 +374,7 @@ declare const requestExampleSchema: z.ZodObject<{
             file?: File | undefined;
             refUid?: string | undefined;
         }[] | undefined;
-        headers?: {
+        cookies?: {
             value?: string | number | undefined;
             description?: string | undefined;
             key?: string | undefined;
@@ -382,7 +382,7 @@ declare const requestExampleSchema: z.ZodObject<{
             file?: File | undefined;
             refUid?: string | undefined;
         }[] | undefined;
-        query?: {
+        headers?: {
             value?: string | number | undefined;
             description?: string | undefined;
             key?: string | undefined;
@@ -417,8 +417,8 @@ export type RequestExample = z.infer<typeof requestExampleSchema>;
 export type RequestExamplePayload = z.input<typeof requestExampleSchema>;
 /** Create request example helper */
 export declare const createRequestExample: (payload: RequestExamplePayload) => {
-    name: string;
     uid: string;
+    name: string;
     parameters: {
         path: {
             value: string;
@@ -428,7 +428,7 @@ export declare const createRequestExample: (payload: RequestExamplePayload) => {
             file?: File | undefined;
             refUid?: string | undefined;
         }[];
-        cookies: {
+        query: {
             value: string;
             key: string;
             enabled: boolean;
@@ -436,7 +436,7 @@ export declare const createRequestExample: (payload: RequestExamplePayload) => {
             file?: File | undefined;
             refUid?: string | undefined;
         }[];
-        headers: {
+        cookies: {
             value: string;
             key: string;
             enabled: boolean;
@@ -444,7 +444,7 @@ export declare const createRequestExample: (payload: RequestExamplePayload) => {
             file?: File | undefined;
             refUid?: string | undefined;
         }[];
-        query: {
+        headers: {
             value: string;
             key: string;
             enabled: boolean;

package/dist/entities/workspace/spec/requests.d.ts

@@ -3,7 +3,12 @@ import type { OpenAPIV3_1 } from 'openapi-types';
 import { z } from 'zod';
 import type { RequestExample } from './request-examples.js';
 /** A single set of populated values for a sent request */
-export type ResponseInstance = AxiosResponse;
+export type ResponseInstance = AxiosResponse & {
+    /**
+     * Time in ms the request took
+     **/
+    duration: number;
+};
 /** A single request/response set to save to the history stack */
 export type RequestEvent = {
     request: RequestExample;
@@ -16,6 +21,7 @@ declare const requestSchema: z.ZodObject<{
     ref: z.ZodDefault<z.ZodNullable<z.ZodObject<{
         path: z.ZodString;
         collectionRef: z.ZodOptional<z.ZodString>;
+        /** A single request/response set to save to the history stack */
         isExternal: z.ZodBoolean;
     }, "strip", z.ZodTypeAny, {
         path: string;
@@ -46,15 +52,23 @@ declare const requestSchema: z.ZodObject<{
         cookies: z.ZodRecord<z.ZodString, z.ZodAny>;
     }, "strip", z.ZodTypeAny, {
         path: Record<string, any>;
+        query: Record<string, any>;
         cookies: Record<string, any>;
         headers: Record<string, any>;
-        query: Record<string, any>;
     }, {
         path: Record<string, any>;
+        query: Record<string, any>;
         cookies: Record<string, any>;
         headers: Record<string, any>;
-        query: Record<string, any>;
     }>>;
+    /**
+     * A declaration of which security mechanisms can be used across the API. The list of
+     * values includes alternative security requirement objects that can be used. Only
+     * one of the security requirement objects need to be satisfied to authorize a request.
+     * Individual operations can override this definition. To make security optional, an empty
+     * security requirement ({}) can be included in the array.
+     */
+    security: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>>, "many">>;
     /**
      * The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the
      * HTTP 1.1 specification [RFC7231] has explicitly defined semantics for request bodies. In other cases where the
@@ -67,15 +81,15 @@ declare const requestSchema: z.ZodObject<{
     history: z.ZodDefault<z.ZodArray<z.ZodAny, "many">>;
 }, "strip", z.ZodTypeAny, {
     path: string;
-    tags: string[];
     uid: string;
+    tags: string[];
     childUids: string[];
     method: "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS";
     parameters: {
         path: Record<string, any>;
+        query: Record<string, any>;
         cookies: Record<string, any>;
         headers: Record<string, any>;
-        query: Record<string, any>;
     };
     ref: {
         path: string;
@@ -83,23 +97,25 @@ declare const requestSchema: z.ZodObject<{
         collectionRef?: string | undefined;
     } | null;
     history: any[];
-    summary?: string | undefined;
     description?: string | undefined;
+    summary?: string | undefined;
+    security?: Record<string, string[]>[] | undefined;
     operationId?: string | undefined;
     requestBody?: any;
 }, {
     path?: string | undefined;
-    summary?: string | undefined;
+    uid?: string | undefined;
     description?: string | undefined;
+    summary?: string | undefined;
+    security?: Record<string, string[] | undefined>[] | undefined;
     tags?: string[] | undefined;
-    uid?: string | undefined;
     childUids?: (string | undefined)[] | undefined;
     method?: "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS" | undefined;
     parameters?: {
         path: Record<string, any>;
+        query: Record<string, any>;
         cookies: Record<string, any>;
         headers: Record<string, any>;
-        query: Record<string, any>;
     } | undefined;
     ref?: {
         path: string;
@@ -124,15 +140,15 @@ export type RequestPayload = z.input<typeof requestSchema> & {
 /** Create request helper */
 export declare const createRequest: (payload: RequestPayload) => {
     path: string;
-    tags: string[];
     uid: string;
+    tags: string[];
     childUids: string[];
     method: "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS";
     parameters: {
         path: Record<string, any>;
+        query: Record<string, any>;
         cookies: Record<string, any>;
         headers: Record<string, any>;
-        query: Record<string, any>;
     };
     ref: {
         path: string;
@@ -140,8 +156,9 @@ export declare const createRequest: (payload: RequestPayload) => {
         collectionRef?: string | undefined;
     } | null;
     history: any[];
-    summary?: string | undefined;
     description?: string | undefined;
+    summary?: string | undefined;
+    security?: Record<string, string[]>[] | undefined;
     operationId?: string | undefined;
     requestBody?: any;
 };

package/dist/entities/workspace/spec/requests.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/spec/requests.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,aAAa,CAAA;AAE5C,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,gBAAgB,CAAA;CAC3B,CAAA;AAQD,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;IAQjB;;OAEG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;OAGG;;;;;;;;;;;;;;;;;;IAUH;;;;;OAKG;;IAEH,0CAA0C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG1C,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IACpD,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AACD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IAC3D,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AAED,4BAA4B;AAC5B,eAAO,MAAM,aAAa,YAAa,cAAc;;;;;;;;;;;;;;;;;;;;;;CACR,CAAA"}
+{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/spec/requests.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C;;QAEI;IACJ,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,gBAAgB,CAAA;CAC3B,CAAA;AAQD,QAAA,MAAM,aAAa;;;;;;;QAZnB,iEAAiE;;;;;;;;;;;IAoB/D;;OAEG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;OAGG;;;;;;;;;;;;;;;;;;IAUH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH,0CAA0C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG1C,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IACpD,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AACD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IAC3D,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AAED,4BAA4B;AAC5B,eAAO,MAAM,aAAa,YAAa,cAAc;;;;;;;;;;;;;;;;;;;;;;;CACR,CAAA"}

package/dist/entities/workspace/spec/requests.js

@@ -2,6 +2,7 @@ import { z } from 'zod';
 import { $refSchema } from './refs.js';
 import { REQUEST_METHODS } from '../../../helpers/httpMethods.js';
 import { nanoidSchema } from '../shared/utility.js';
+import { securityRequirement } from '../security/security-requirement.js';
 import { deepMerge } from '../../../helpers/deepMerge.js';
 
 const requestBodySchema = z.any();
@@ -35,6 +36,14 @@ const requestSchema = z.object({
         cookies: parametersSchema,
     })
         .default({ path: {}, query: {}, headers: {}, cookies: {} }),
+    /**
+     * A declaration of which security mechanisms can be used across the API. The list of
+     * values includes alternative security requirement objects that can be used. Only
+     * one of the security requirement objects need to be satisfied to authorize a request.
+     * Individual operations can override this definition. To make security optional, an empty
+     * security requirement ({}) can be included in the array.
+     */
+    security: z.array(securityRequirement).optional(),
     /**
      * The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the
      * HTTP 1.1 specification [RFC7231] has explicitly defined semantics for request bodies. In other cases where the

package/dist/entities/workspace/workspace.d.ts

@@ -13,17 +13,17 @@ declare const workspaceSchema: z.ZodObject<{
     /** List of all cookie uids in a given workspace */
     cookieUids: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
 }, "strip", z.ZodTypeAny, {
-    name: string;
-    description: string;
     uid: string;
+    description: string;
+    name: string;
     isReadOnly: boolean;
     collectionUids: string[];
     environmentUids: string[];
     cookieUids: string[];
 }, {
-    name?: string | undefined;
-    description?: string | undefined;
     uid?: string | undefined;
+    description?: string | undefined;
+    name?: string | undefined;
     isReadOnly?: boolean | undefined;
     collectionUids?: string[] | undefined;
     environmentUids?: string[] | undefined;
@@ -33,9 +33,9 @@ declare const workspaceSchema: z.ZodObject<{
 export type Workspace = z.infer<typeof workspaceSchema>;
 export type WorkspacePayload = z.input<typeof workspaceSchema>;
 export declare const createWorkspace: (payload: WorkspacePayload) => {
-    name: string;
-    description: string;
     uid: string;
+    description: string;
+    name: string;
     isReadOnly: boolean;
     collectionUids: string[];
     environmentUids: string[];

package/dist/helpers/index.d.ts

@@ -6,9 +6,10 @@ export * from './httpStatusCodes.js';
 export * from './iterateTitle.js';
 export * from './normalizeMimeType.js';
 export * from './normalizeMimeTypeObject.js';
-export * from './objectMerge.js';
+export * from './object.js';
 export * from './parse.js';
 export * from './prettyPrintJson.js';
 export * from './schema-model.js';
 export * from './ssrState.js';
+export * from './string.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,2BAA2B,CAAA;AACzC,cAAc,eAAe,CAAA;AAC7B,cAAc,SAAS,CAAA;AACvB,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,2BAA2B,CAAA;AACzC,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA"}

package/dist/helpers/index.js

@@ -6,8 +6,9 @@ export { httpStatusCodes } from './httpStatusCodes.js';
 export { iterateTitle } from './iterateTitle.js';
 export { normalizeMimeType } from './normalizeMimeType.js';
 export { normalizeMimeTypeObject } from './normalizeMimeTypeObject.js';
-export { objectMerge } from './objectMerge.js';
+export { getObjectKeys, objectMerge } from './object.js';
 export { formatJsonOrYamlString, isJsonString, json, parseJsonOrYaml, transformToJson, yaml } from './parse.js';
-export { prettyPrintJson } from './prettyPrintJson.js';
+export { prettyPrintJson, replaceCircularDependencies } from './prettyPrintJson.js';
 export { schemaModel } from './schema-model.js';
 export { defaultStateFactory, ssrState } from './ssrState.js';
+export { camelToTitleWords } from './string.js';

package/dist/helpers/object.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Overwrite a target object a new replacement object handling removed keys
+ **/
+export declare function objectMerge<A extends object, B extends object>(target: A, replacement: B): B;
+/**
+ * Type safe version of Object.keys
+ * Can probably remove this whenever typescript adds it
+ */
+export declare const getObjectKeys: <T extends object>(obj: T) => (keyof T)[];
+//# sourceMappingURL=object.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/helpers/object.ts"],"names":[],"mappings":"AACA;;IAEI;AACJ,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAC5D,MAAM,EAAE,CAAC,EACT,WAAW,EAAE,CAAC,KAYf;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,0BAA2B,CAAC,KAAG,CAAC,MAAM,CAAC,CAAC,EACjC,CAAA"}

package/dist/helpers/{objectMerge.js → object.js}

@@ -12,5 +12,10 @@ function objectMerge(target, replacement) {
     Object.assign(target, replacement);
     return target;
 }
+/**
+ * Type safe version of Object.keys
+ * Can probably remove this whenever typescript adds it
+ */
+const getObjectKeys = (obj) => Object.keys(obj);
 
-export { objectMerge };
+export { getObjectKeys, objectMerge };

package/dist/helpers/prettyPrintJson.d.ts

@@ -1,5 +1,9 @@
 /**
  * Takes JSON and formats it.
  **/
-export declare const prettyPrintJson: (value: any) => any;
+export declare const prettyPrintJson: (value: string | number | any[] | Record<any, any>) => string;
+/**
+ * JSON.stringify, but with circular dependencies replaced with '[Circular]'
+ */
+export declare function replaceCircularDependencies(content: any): string;
 //# sourceMappingURL=prettyPrintJson.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"prettyPrintJson.d.ts","sourceRoot":"","sources":["../../src/helpers/prettyPrintJson.ts"],"names":[],"mappings":"AAAA;;IAEI;AACJ,eAAO,MAAM,eAAe,UAAW,GAAG,QAYzC,CAAA"}
+{"version":3,"file":"prettyPrintJson.d.ts","sourceRoot":"","sources":["../../src/helpers/prettyPrintJson.ts"],"names":[],"mappings":"AAEA;;IAEI;AACJ,eAAO,MAAM,eAAe,UACnB,MAAM,GAAG,MAAM,GAAG,GAAG,EAAE,GAAG,OAAO,GAAG,EAAE,GAAG,CAAC,WAsBlD,CAAA;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,GAAG,UAiBvD"}

package/dist/helpers/prettyPrintJson.js

@@ -1,19 +1,42 @@
+import { isJsonString } from './parse.js';
+
 /**
  * Takes JSON and formats it.
  **/
 const prettyPrintJson = (value) => {
-    try {
-        if (typeof value === 'string') {
+    if (typeof value === 'string') {
+        // JSON string
+        if (isJsonString(value)) {
             return JSON.stringify(JSON.parse(value), null, 2);
         }
-        else {
+        // Regular string
+        return value;
+    }
+    // Object
+    if (typeof value === 'object') {
+        try {
             return JSON.stringify(value, null, 2);
         }
+        catch {
+            return replaceCircularDependencies(value);
+        }
     }
-    catch {
-        console.log('[prettyPrintJson] Error parsing JSON', value);
-        return value;
-    }
+    return value.toString();
 };
+/**
+ * JSON.stringify, but with circular dependencies replaced with '[Circular]'
+ */
+function replaceCircularDependencies(content) {
+    const cache = new Set();
+    return JSON.stringify(content, (key, value) => {
+        if (typeof value === 'object' && value !== null) {
+            if (cache.has(value)) {
+                return '[Circular]';
+            }
+            cache.add(value);
+        }
+        return value;
+    }, 2);
+}
 
-export { prettyPrintJson };
+export { prettyPrintJson, replaceCircularDependencies };

package/dist/helpers/string.d.ts

@@ -0,0 +1,10 @@
+/**
+ * A collection of string manipulation helper methods
+ */
+/**
+ * Converts a camelCase string to Title Words with spaces
+ *
+ * @param camelStr - MUST be in camelCase or this might not work
+ */
+export declare const camelToTitleWords: (camelStr: string) => string;
+//# sourceMappingURL=string.d.ts.map