JSON Pointer Utilities

/**
 * Retrieves a value from a JSON document by a JSON pointer.
 * Returns the value.
 * @param document The document to get the value from
 * @param pointer An escaped JSON pointer
 * @returns The retrieved value
 */
function getValueByPointer(document: any, pointer: string): any;

import { getValueByPointer } from "fast-json-patch";

const document = {
  users: [
    { 
      name: "Alice", 
      contact: { 
        email: "alice@example.com",
        phone: "555-0123" 
      }
    },
    { 
      name: "Bob",
      contact: {
        email: "bob@example.com" 
      }
    }
  ],
  metadata: {
    version: "1.0",
    "special/key": "value with slash",
    "tilde~key": "value with tilde"
  }
};

// Basic pointer usage
const firstUser = getValueByPointer(document, "/users/0");
// { name: "Alice", contact: { email: "alice@example.com", phone: "555-0123" } }

// Deep nested access
const email = getValueByPointer(document, "/users/0/contact/email");
// "alice@example.com"

// Array index access
const secondUserName = getValueByPointer(document, "/users/1/name");
// "Bob"

// Root document access
const entireDoc = getValueByPointer(document, "");
// Returns the entire document

// Special characters in keys (escaped)
const specialValue = getValueByPointer(document, "/metadata/special~1key");
// "value with slash"

const tildeValue = getValueByPointer(document, "/metadata/tilde~0key");
// "value with tilde"

/**
 * Escapes a json pointer path component
 * @param path The raw pointer component
 * @returns The escaped path component
 */
function escapePathComponent(path: string): string;

import { escapePathComponent } from "fast-json-patch";

// Escape forward slashes and tildes
const escaped1 = escapePathComponent("user/profile");  // "user~1profile"
const escaped2 = escapePathComponent("tilde~value");   // "tilde~0value"
const escaped3 = escapePathComponent("both/and~");     // "both~1and~0"

// No escaping needed
const escaped4 = escapePathComponent("normalkey");     // "normalkey"

// Use in path construction
const userKey = "user/admin";
const fullPath = "/" + escapePathComponent(userKey);   // "/user~1admin"

/**
 * Unescapes a json pointer path component
 * @param path The escaped pointer component
 * @returns The unescaped path component
 */
function unescapePathComponent(path: string): string;

import { unescapePathComponent } from "fast-json-patch";

// Unescape sequences
const unescaped1 = unescapePathComponent("user~1profile");  // "user/profile"
const unescaped2 = unescapePathComponent("tilde~0value");   // "tilde~value"
const unescaped3 = unescapePathComponent("both~1and~0");    // "both/and~"

// No unescaping needed
const unescaped4 = unescapePathComponent("normalkey");      // "normalkey"

/**
 * Deeply clone the object.
 * @param obj Value to clone
 * @returns Cloned object
 */
function deepClone(obj: any): any;

import { deepClone } from "fast-json-patch";

const original = {
  name: "Alice",
  hobbies: ["reading", "swimming"],
  profile: {
    age: 25,
    preferences: {
      theme: "dark",
      notifications: true
    }
  }
};

// Deep clone the object
const cloned = deepClone(original);

// Modify the clone
cloned.name = "Bob";
cloned.hobbies.push("cycling");
cloned.profile.age = 30;

// Original remains unchanged
console.log(original.name);        // "Alice"
console.log(original.hobbies);     // ["reading", "swimming"]
console.log(original.profile.age); // 25

// Handle special values
const specialCloned = deepClone(undefined); // null (JSON behavior)
const primitiveCloned = deepClone(42);      // 42
const stringCloned = deepClone("hello");    // "hello"