@scalar/json-magic 0.1.0

package/src/magic-proxy/proxy.ts

@@ -0,0 +1,225 @@
+import { isReactive, toRaw } from 'vue'
+import { isLocalRef } from '@/bundle/bundle'
+import type { UnknownObject } from '@/types'
+import { isObject } from '@/utils/is-object'
+import { getValueByPath, parseJsonPointer } from '@/utils/json-path-utils'
+
+const isMagicProxy = Symbol('isMagicProxy')
+
+/**
+ * Creates a proxy handler that automatically resolves JSON references ($ref) in an object.
+ * The handler intercepts property access, assignment, and property enumeration to automatically
+ * resolve any $ref references to their target values in the source document.
+ *
+ * @param sourceDocument - The source document containing the reference targets
+ * @param resolvedProxyCache - Optional cache to store resolved proxies and prevent duplicate proxies
+ * @returns A proxy handler that automatically resolves $ref references
+ */
+function createProxyHandler(
+  sourceDocument: UnknownObject | UnknownObject[],
+  resolvedProxyCache?: WeakMap<object, UnknownObject | UnknownObject[]>,
+): ProxyHandler<UnknownObject | UnknownObject[]> {
+  return {
+    get(target, property, receiver) {
+      if (property === TARGET_SYMBOL) {
+        return target
+      }
+
+      if (property === isMagicProxy) {
+        return true
+      }
+
+      const value = Reflect.get(target, property, receiver)
+
+      /**
+       * Recursively resolves nested references in an object.
+       * If the value is not an object, returns it as is.
+       * If the value has a $ref property:
+       *   - For local references: resolves the reference and continues resolving nested refs
+       *   - For all other objects: creates a proxy for lazy resolution
+       */
+      const deepResolveNestedRefs = (value: unknown, originalRef?: string) => {
+        if (!isObject(value) && !Array.isArray(value)) {
+          return value
+        }
+
+        if (typeof value === 'object' && '$ref' in value) {
+          const ref = value.$ref as string
+
+          if (isLocalRef(ref)) {
+            const referencePath = parseJsonPointer(ref)
+            const resolvedValue = getValueByPath(sourceDocument, referencePath)
+
+            // preserve the first $ref to maintain the original reference
+            return deepResolveNestedRefs(resolvedValue, originalRef ?? ref)
+          }
+        }
+
+        if (originalRef && typeof value === 'object') {
+          return createMagicProxy({ ...value, 'x-original-ref': originalRef }, sourceDocument, resolvedProxyCache)
+        }
+
+        return createMagicProxy(value as UnknownObject, sourceDocument, resolvedProxyCache)
+      }
+
+      return deepResolveNestedRefs(value)
+    },
+
+    set(target: UnknownObject, property: string, newValue: unknown, receiver: UnknownObject) {
+      const rawTarget = isReactive(target) ? toRaw(target) : target
+      const currentValue = rawTarget[property]
+
+      if (
+        typeof currentValue === 'object' &&
+        isObject(currentValue) &&
+        '$ref' in currentValue &&
+        typeof currentValue.$ref === 'string' &&
+        isLocalRef(currentValue.$ref)
+      ) {
+        const referencePath = parseJsonPointer(currentValue.$ref)
+        const targetObject = getValueByPath(sourceDocument, referencePath.slice(0, -1)) as UnknownObject
+        const lastPathSegment = referencePath[referencePath.length - 1]
+
+        if (targetObject && lastPathSegment) {
+          targetObject[lastPathSegment] = newValue
+        }
+      } else {
+        Reflect.set(rawTarget, property, newValue, receiver)
+      }
+      return true
+    },
+
+    has(target: UnknownObject, key: string) {
+      if (typeof key === 'string' && key !== '$ref' && typeof target.$ref === 'string' && isLocalRef(target.$ref)) {
+        const referencePath = parseJsonPointer(target['$ref'])
+        const resolvedValue = getValueByPath(sourceDocument, referencePath) as UnknownObject
+
+        return resolvedValue ? key in resolvedValue : false
+      }
+
+      return key in target
+    },
+
+    ownKeys(target: UnknownObject) {
+      if ('$ref' in target && typeof target.$ref === 'string' && isLocalRef(target.$ref)) {
+        const referencePath = parseJsonPointer(target['$ref'])
+        const resolvedValue = getValueByPath<UnknownObject>(sourceDocument, referencePath)
+
+        return resolvedValue ? Reflect.ownKeys(resolvedValue) : []
+      }
+
+      return Reflect.ownKeys(target)
+    },
+
+    getOwnPropertyDescriptor(target: UnknownObject, key: string) {
+      if ('$ref' in target && key !== '$ref' && typeof target.$ref === 'string' && isLocalRef(target.$ref)) {
+        const referencePath = parseJsonPointer(target['$ref'])
+        const resolvedValue = getValueByPath(sourceDocument, referencePath)
+
+        if (resolvedValue) {
+          return Object.getOwnPropertyDescriptor(resolvedValue, key)
+        }
+      }
+
+      return Object.getOwnPropertyDescriptor(target, key)
+    },
+  }
+}
+
+/**
+ * Creates a proxy that automatically resolves JSON references ($ref) in an object.
+ * The proxy intercepts property access and automatically resolves any $ref references
+ * to their target values in the source document.
+ *
+ * @param targetObject - The object to create a proxy for
+ * @param sourceDocument - The source document containing the reference targets (defaults to targetObject)
+ * @param resolvedProxyCache - Optional cache to store resolved proxies and prevent duplicate proxies
+ * @returns A proxy that automatically resolves $ref references
+ *
+ * @example
+ * // Basic usage with local references
+ * const doc = {
+ *   components: {
+ *     schemas: {
+ *       User: { type: 'object', properties: { name: { type: 'string' } } }
+ *     }
+ *   },
+ *   paths: {
+ *     '/users': {
+ *       get: {
+ *         responses: {
+ *           200: {
+ *             content: {
+ *               'application/json': {
+ *                 schema: { $ref: '#/components/schemas/User' }
+ *               }
+ *             }
+ *           }
+ *         }
+ *       }
+ *     }
+ *   }
+ * }
+ *
+ * const proxy = createMagicProxy(doc)
+ * // Accessing the schema will automatically resolve the $ref
+ * console.log(proxy.paths['/users'].get.responses[200].content['application/json'].schema)
+ * // Output: { type: 'object', properties: { name: { type: 'string' } } }
+ *
+ * @example
+ * // Using with a cache to prevent duplicate proxies
+ * const cache = new WeakMap()
+ * const proxy1 = createMagicProxy(doc, doc, cache)
+ * const proxy2 = createMagicProxy(doc, doc, cache)
+ * // proxy1 and proxy2 are the same instance due to caching
+ * console.log(proxy1 === proxy2) // true
+ */
+export function createMagicProxy<T extends UnknownObject | UnknownObject[]>(
+  targetObject: T,
+  sourceDocument: T = targetObject,
+  resolvedProxyCache?: WeakMap<object, T>,
+): T {
+  if (!isObject(targetObject) && !Array.isArray(targetObject)) {
+    return targetObject
+  }
+
+  const rawTarget = isReactive(targetObject) ? toRaw(targetObject) : targetObject
+
+  // check for cached results
+  if (resolvedProxyCache?.has(rawTarget)) {
+    const cachedValue = resolvedProxyCache.get(rawTarget)
+
+    if (cachedValue) {
+      return cachedValue
+    }
+  }
+
+  // Create a handler with the correct context
+  const handler = createProxyHandler(sourceDocument, resolvedProxyCache)
+  const proxy = new Proxy<T>(rawTarget, handler)
+
+  if (resolvedProxyCache) {
+    resolvedProxyCache.set(rawTarget, proxy)
+  }
+
+  return proxy
+}
+
+export const TARGET_SYMBOL = Symbol('magicProxyTarget')
+/**
+ * Gets the raw (non-proxied) version of an object created by createMagicProxy.
+ * This is useful when you need to access the original object without the magic proxy wrapper.
+ *
+ * @param obj - The magic proxy object to get the raw version of
+ * @returns The raw version of the object
+ * @example
+ * const proxy = createMagicProxy({ foo: { $ref: '#/bar' } })
+ * const raw = getRaw(proxy) // { foo: { $ref: '#/bar' } }
+ */
+export function getRaw<T extends UnknownObject>(obj: T): T {
+  if ((obj as T & { [isMagicProxy]: boolean | undefined })[isMagicProxy]) {
+    return (obj as T & { [TARGET_SYMBOL]: T })[TARGET_SYMBOL]
+  }
+
+  return obj
+}

package/src/polyfills/index.ts

@@ -0,0 +1,12 @@
+export {
+  resolve,
+  normalize,
+  isAbsolute,
+  join,
+  relative,
+  sep,
+  delimiter,
+  dirname,
+  basename,
+  extname,
+} from './path'

package/src/polyfills/path.ts

@@ -0,0 +1,248 @@
+// @ts-nocheck
+
+// Copyright Joyent, Inc. and other Node contributors.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to permit
+// persons to whom the Software is furnished to do so, subject to the
+// following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+// USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+// resolves . and .. elements in a path array with directory names there
+// must be no slashes, empty elements, or device names (c:\) in the array
+// (so also no leading and trailing slashes - it does not distinguish
+// relative and absolute paths)
+function normalizeArray(parts, allowAboveRoot) {
+  // if the path tries to go above the root, `up` ends up > 0
+  let up = 0
+  for (let i = parts.length - 1; i >= 0; i--) {
+    const last = parts[i]
+    if (last === '.') {
+      parts.splice(i, 1)
+    } else if (last === '..') {
+      parts.splice(i, 1)
+      up++
+    } else if (up) {
+      parts.splice(i, 1)
+      up--
+    }
+  }
+
+  // if the path is allowed to go above the root, restore leading ..s
+  if (allowAboveRoot) {
+    for (; up--; up) {
+      parts.unshift('..')
+    }
+  }
+
+  return parts
+}
+
+// Split a filename into [root, dir, basename, ext], unix version
+// 'root' is just a slash, or nothing.
+const splitPathRe = /^(\/?|)([\s\S]*?)((?:\.{1,2}|[^/]+?|)(\.[^./]*|))(?:[/]*)$/
+const splitPath = (filename) => splitPathRe.exec(filename).slice(1)
+
+// path.resolve([from ...], to)
+// posix version
+export function resolve(...parameters) {
+  let resolvedPath = '',
+    resolvedAbsolute = false
+
+  for (let i = parameters.length - 1; i >= -1 && !resolvedAbsolute; i--) {
+    const path = i >= 0 ? parameters[i] : '/'
+
+    // Skip empty and invalid entries
+    if (typeof path !== 'string') {
+      throw new TypeError('Arguments to path.resolve must be strings')
+    }
+    if (!path) {
+      continue
+    }
+
+    resolvedPath = path + '/' + resolvedPath
+    resolvedAbsolute = path.charAt(0) === '/'
+  }
+
+  // At this point the path should be resolved to a full absolute path, but
+  // handle relative paths to be safe (might happen when process.cwd() fails)
+
+  // Normalize the path
+  resolvedPath = normalizeArray(
+    filter(resolvedPath.split('/'), (p) => !!p),
+    !resolvedAbsolute,
+  ).join('/')
+
+  return (resolvedAbsolute ? '/' : '') + resolvedPath || '.'
+}
+
+// path.normalize(path)
+// posix version
+export function normalize(path) {
+  const isPathAbsolute = isAbsolute(path),
+    trailingSlash = substr(path, -1) === '/'
+
+  // Normalize the path
+  path = normalizeArray(
+    filter(path.split('/'), (p) => !!p),
+    !isPathAbsolute,
+  ).join('/')
+
+  if (!path && !isPathAbsolute) {
+    path = '.'
+  }
+  if (path && trailingSlash) {
+    path += '/'
+  }
+
+  return (isPathAbsolute ? '/' : '') + path
+}
+
+// posix version
+export function isAbsolute(path) {
+  return path.charAt(0) === '/'
+}
+
+// posix version
+export function join(...paths: string[]) {
+  return normalize(
+    filter(paths, (p, _index) => {
+      if (typeof p !== 'string') {
+        throw new TypeError('Arguments to path.join must be strings')
+      }
+      return p
+    }).join('/'),
+  )
+}
+
+// path.relative(from, to)
+// posix version
+export function relative(from, to) {
+  from = resolve(from).substr(1)
+  to = resolve(to).substr(1)
+
+  function trim(arr) {
+    let start = 0
+    for (; start < arr.length; start++) {
+      if (arr[start] !== '') {
+        break
+      }
+    }
+
+    let end = arr.length - 1
+    for (; end >= 0; end--) {
+      if (arr[end] !== '') {
+        break
+      }
+    }
+
+    if (start > end) {
+      return []
+    }
+    return arr.slice(start, end - start + 1)
+  }
+
+  const fromParts = trim(from.split('/'))
+  const toParts = trim(to.split('/'))
+
+  const length = Math.min(fromParts.length, toParts.length)
+  let samePartsLength = length
+  for (let i = 0; i < length; i++) {
+    if (fromParts[i] !== toParts[i]) {
+      samePartsLength = i
+      break
+    }
+  }
+
+  let outputParts = []
+  for (let i = samePartsLength; i < fromParts.length; i++) {
+    outputParts.push('..')
+  }
+
+  outputParts = outputParts.concat(toParts.slice(samePartsLength))
+
+  return outputParts.join('/')
+}
+
+export const sep = '/'
+export const delimiter = ':'
+
+export function dirname(path) {
+  const result = splitPath(path),
+    root = result[0]
+
+  let dir = result[1]
+
+  if (!root && !dir) {
+    // No dirname whatsoever
+    return '.'
+  }
+
+  if (dir) {
+    // It has a dirname, strip trailing slash
+    dir = dir.substr(0, dir.length - 1)
+  }
+
+  return root + dir
+}
+
+export function basename(path, ext) {
+  let f = splitPath(path)[2]
+  // TODO: make this comparison case-insensitive on windows?
+  if (ext && f.substr(-1 * ext.length) === ext) {
+    f = f.substr(0, f.length - ext.length)
+  }
+  return f
+}
+
+export function extname(path) {
+  return splitPath(path)[3]
+}
+export default {
+  extname: extname,
+  basename: basename,
+  dirname: dirname,
+  sep: sep,
+  delimiter: delimiter,
+  relative: relative,
+  join: join,
+  isAbsolute: isAbsolute,
+  normalize: normalize,
+  resolve: resolve,
+}
+function filter(xs, f) {
+  if (xs.filter) {
+    return xs.filter(f)
+  }
+  const res = []
+  for (let i = 0; i < xs.length; i++) {
+    if (f(xs[i], i, xs)) {
+      res.push(xs[i])
+    }
+  }
+  return res
+}
+
+// String.prototype.substr - negative index don't work in IE8
+const substr =
+  'ab'.substr(-1) === 'b'
+    ? (str, start, len) => str.substr(start, len)
+    : (str, start, len) => {
+        if (start < 0) {
+          start = str.length + start
+        }
+        return str.substr(start, len)
+      }

package/src/types.ts

@@ -0,0 +1 @@
+export type UnknownObject = Record<string, unknown>

package/src/utils/escape-json-pointer.test.ts

@@ -0,0 +1,13 @@
+import { describe, expect, it } from 'vitest'
+
+import { escapeJsonPointer } from './escape-json-pointer'
+
+describe('escapeJsonPointer', async () => {
+  it('should escape a slash', () => {
+    expect(escapeJsonPointer('application/json')).toBe('application~1json')
+  })
+
+  it('should escape multiple slashes', () => {
+    expect(escapeJsonPointer('/api/users/{id}/reports')).toBe('~1api~1users~1{id}~1reports')
+  })
+})

package/src/utils/escape-json-pointer.ts

@@ -0,0 +1,8 @@
+/**
+ * Escapes a JSON pointer string.
+ *
+ * Example: `/foo/bar~baz` -> `/foo~1bar~0baz`
+ */
+export function escapeJsonPointer(str: string) {
+  return str.replace(/~/g, '~0').replace(/\//g, '~1')
+}

package/src/utils/get-segments-from-path.test.ts

@@ -0,0 +1,17 @@
+import { describe, expect, it } from 'vitest'
+
+import { getSegmentsFromPath } from './get-segments-from-path'
+
+describe('getSegmentsFromPath', () => {
+  it('returns path segments', () => {
+    const result = getSegmentsFromPath('/paths/test')
+
+    expect(result).toEqual(['paths', 'test'])
+  })
+
+  it('unescaped slashes', () => {
+    const result = getSegmentsFromPath('/paths/~1test')
+
+    expect(result).toEqual(['paths', '/test'])
+  })
+})

package/src/utils/get-segments-from-path.ts

@@ -0,0 +1,17 @@
+import { unescapeJsonPointer } from './unescape-json-pointer'
+
+/**
+ * Translate `/paths/~1test` to `['paths', '/test']`
+ */
+export function getSegmentsFromPath(path: string) {
+  return (
+    // /paths/~1test
+    path
+      // ['', 'paths', '~1test']
+      .split('/')
+      // ['paths', '~test']
+      .slice(1)
+      // ['paths', '/test']
+      .map(unescapeJsonPointer)
+  )
+}

package/src/utils/is-json-object.ts

@@ -0,0 +1,31 @@
+import { isObject } from '@/utils/is-object'
+
+/**
+ * Determines if a string represents a valid JSON object (i.e., a plain object, not an array, primitive, or null).
+ * The function first checks if the string appears to start with an opening curly brace (ignoring leading whitespace),
+ * which is a quick heuristic to rule out arrays, primitives, and most invalid JSON. If this check passes,
+ * it attempts to parse the string with JSON.parse. The result is then checked to ensure it is a plain object
+ * (not an array, null, or primitive) using the isObject utility.
+ *
+ * @param value - The string to evaluate
+ * @returns true if the string is valid JSON and parses to a plain object, false otherwise
+ *
+ * @example
+ * isJsonObject('{"foo": "bar"}') // true
+ * isJsonObject('[1,2,3]') // false
+ * isJsonObject('not json') // false
+ * isJsonObject('42') // false
+ */
+export function isJsonObject(value: string) {
+  // Quickly rule out anything that doesn't start with an object brace
+  if (!/^\s*(\{)/.test(value.slice(0, 500))) {
+    return false
+  }
+
+  try {
+    const val = JSON.parse(value)
+    return isObject(val)
+  } catch {
+    return false
+  }
+}

package/src/utils/is-object.test.ts

@@ -0,0 +1,27 @@
+import { describe, expect, it } from 'vitest'
+
+import { isObject } from './is-object'
+
+describe('isObject', () => {
+  it('returns true for an object', () => {
+    const result = isObject({
+      foo: 'bar',
+    })
+    expect(result).toBe(true)
+  })
+
+  it('returns true for an empty object', () => {
+    const result = isObject({})
+    expect(result).toBe(true)
+  })
+
+  it('returns false for a string', () => {
+    const result = isObject('foo')
+    expect(result).toBe(false)
+  })
+
+  it('returns false for an array', () => {
+    const result = isObject([])
+    expect(result).toBe(false)
+  })
+})

package/src/utils/is-object.ts

@@ -0,0 +1,4 @@
+/**
+ * Check if the given value is an object
+ */
+export const isObject = (obj: any) => typeof obj === 'object' && !Array.isArray(obj) && obj !== null

package/src/utils/is-yaml.ts

@@ -0,0 +1,18 @@
+/**
+ * Checks if a string appears to be YAML content.
+ * This function uses a simple heuristic: it looks for a line that starts with an optional dash,
+ * followed by a key (alphanumeric or dash), a colon, and a value, and then at least one more line.
+ * This is not a full YAML parser, but works for basic detection.
+ *
+ * @param value - The string to check
+ * @returns true if the string looks like YAML, false otherwise
+ *
+ * @example
+ * isYaml('openapi: 3.0.0\ninfo:\n  title: Example') // true
+ * isYaml('{"openapi": "3.0.0", "info": {"title": "Example"}}') // false
+ * isYaml('- name: value\n- name: value2') // true
+ * isYaml('type: object') // false (only one line)
+ */
+export function isYaml(value: string): boolean {
+  return /^\s*(?:-\s*)?[\w\-]+\s*:\s*.+\n.*/.test(value)
+}

package/src/utils/json-path-utils.test.ts

@@ -0,0 +1,13 @@
+import { parseJsonPointer } from './json-path-utils'
+import { describe, expect, test } from 'vitest'
+
+describe('parseJsonPointer', () => {
+  test.each([
+    ['#/users/name', ['users', 'name']],
+    ['#/', []],
+    ['', []],
+    ['users/name', ['users', 'name']],
+  ])('should correctly parse json pointers', (a, b) => {
+    expect(parseJsonPointer(a)).toEqual(b)
+  })
+})

package/src/utils/json-path-utils.ts

@@ -0,0 +1,38 @@
+/**
+ * Parses a JSON Pointer string into an array of path segments
+ *
+ * @example
+ * ```ts
+ * parseJsonPointer('#/components/schemas/User')
+ *
+ * ['components', 'schemas', 'User']
+ * ```
+ */
+export function parseJsonPointer(pointer: string): string[] {
+  return (
+    pointer
+      // Split on '/'
+      .split('/')
+      // Remove the leading '#' if present
+      .filter((segment, index) => (index !== 0 || segment !== '#') && segment)
+  )
+}
+
+/**
+ * Retrieves a nested value from the source document using a path array
+ *
+ * @example
+ * ```ts
+ * getValueByPath(document, ['components', 'schemas', 'User'])
+ *
+ * { id: '123', name: 'John Doe' }
+ * ```
+ */
+export function getValueByPath<R = unknown>(obj: any, pointer: string[]): R {
+  return pointer.reduce((acc, part) => {
+    if (acc === undefined || acc === null) {
+      return undefined
+    }
+    return acc[part]
+  }, obj)
+}