Wondering what’s next for npm?Check out our public roadmap! »

    @threads/json-patch-ot
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.0 • Public • Published

    json-patch-ot

    Library to reconcile JSON patch changes using Operational Transformation

    You must pass the function a list of JSON patches that you want to transform against. These should be your accepted changes that are already accepted by the server, but were not known about at the creation of the second argument, the proposed changes.

    Finally you can pass an options object which currently only supports one option. The acceptedWinsOnEqualPath option will decide if new replace operations should override an accepted replace that was made to the exact same path.

    Note: This project only exposes commonjs es2018 modules.

    Example

    import jsonPatchOT, { Operation } from "@threads/json-patch-ot";
     
    // [0, 1, 2, 3, 4, 5, 6]; <- Starting array
    const acceptedOps: Operation[] = [
      {op: OpType.remove, path: '/array/1'},
      {op: OpType.add, path: '/array/3', value: 30},
    ];
     
    // [0, 2, 3, 30, 4, 5, 6]; <- Array after accepted add and remove
     
    // Actions to double some specific values
    const proposedOps: Operation[] = [
      {op: OpType.replace, path: '/array/2', value: 4}, // 2 -> 4
      {op: OpType.replace, path: '/array/1', value: 2}, // 1 -> 2
      {op: OpType.replace, path: '/array/5', value: 10}, // 5 -> 10
    ];
     
    const result = JSONPatchOT(acceptedOps, proposedOps);
     
    // result === [
    //   {op: OpType.replace, path: '/array/1', value: 4}, <- index changed
    //   // {op: OpType.replace, path: '/array/1', value: 2}, <- removed
    //   {op: OpType.replace, path: '/array/5', value: 10}, <- unchanged
    // ]
     
    // [0, 4, 3, 30, 4, 10, 6]; <- Array after transformed proposed changes
     

    Options

    acceptedWinsOnEqualPath

    For some operation types, the default behaviour is to overwrite if the proposed change has the same path as an accepted change. For example, below, without the option passed, the second replace in the proposedOps would not be remove. This is useful if you want proposed changes only to be able to change a path if they knew the value it had before. Note: remove ops in accepted changes always cause proposed operations with the same path to be deleted.

    import jsonPatchOT, { Operation } from "@threads/json-patch-ot";
     
    const options = {acceptedWinsOnEqualPath: true};
    const acceptedOps: Operation[] = [
      {op: OpType.replace, path: '/toreplace', value: 'new val'}
    ];
    const proposedOps: Operation[] = [
      {op: OpType.replace, path: '/some/other', value: 3},
      {op: OpType.replace, path: '/toreplace', value: 'something else'},
    ];
     
    const result = JSONPatchOT(acceptedOps, proposedOps, options); // options passed here
     
    // result = [
    //   {op: OpType.replace, path: '/some/other', value: 3},
    //   // {op: OpType.replace, path: '/toreplace', value: 'something else'}, <- removed
    // ]

    Acknowledgements

    Thanks to Palindrom's JSON-Patch-OT lib which this was originally built upon.

    License

    MIT

    Work in progress

    Please note: This is a work in progress. You are free to use it how you like, but be aware that you do so at your own risk.

    Install

    npm i @threads/json-patch-ot

    DownloadsWeekly Downloads

    52

    Version

    1.1.0

    License

    ISC

    Unpacked Size

    108 kB

    Total Files

    19

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar