Natural Pleistocene Monsters

    @ovotech/json-refs
    TypeScript icon, indicating that this package has built-in type declarations

    0.3.2 • Public • Published

    JSON Refs

    Recursively downloads files referenced in a json-schema, and resolves all the references and provide a map to the referenced contents while its at it.

    Usage

    yarn add @ovotech/json-refs
    import { resolveRefs } from '@ovotech/json-refs';
    
    // Where the contents of https://example.com/assets/test.yml are
    // UserResponse:
    //   - type: 'object'
    
    const schema = {
      test: { $ref: 'https://example.com/assets/test.yml#/UserResponse' },
    };
    
    const resolved = await resolveRefs(schema);
    
    console.log(resolved);

    Should output

    { schema:
       { test:
          { '$ref': 'https://example.com/assets/test.yaml#/UserResponse' } },
      refs:
       { 'https://example.com/assets/test.yaml': { UserResponse: { type: 'object' } },
         'https://example.com/assets/test.yaml#/UserResponse': { type: 'object' } },
      uris: [ 'https://example.com/assets/test.yaml' ] }

    The resolved refs include all files with their parsed contents (yaml or json), as well as flat list of links to the individual refs. There is also a list of all the files downloaded or local file referenced in uris.

    Behavior

    First of all it would parse the schema, searching for $refs if the refs are in the file itself then it would just return those. If there are any external links, it would collect all the URLs present, and would download all of them in parallel. If there are any external links in the downloaded files, it would attempt another batch, until all resources are resolved.

    Since it would fill in its internal reference library on each pass, circular references are allowed and would only be resolved once.

    Api

    resolveRefs

    function async resolveRefs(schema: JsonPointerObject) => Promise<{
      schema: JsonPointerObject,
      refs: { [key: string]: JsonPointerObject,
      uris: string[]
    }>

    resolveRefsFile The same as resolveRefs, but start with downloading and or parsing the initial schema. Can take any url or path to a local file.

    function async resolveRefsFile(file: string) => Promise<{
      schema: JsonPointerObject,
      refs: { [key: string]: JsonPointerObject,
      uris: string[]
    }>

    Running the tests

    You can run the tests with:

    yarn test

    Coding style (linting, etc) tests

    Style is maintained with prettier and eslint

    yarn lint
    

    Deployment

    Deployment is preferment by lerna automatically on merge / push to master, but you'll need to bump the package version numbers yourself. Only updated packages with newer versions will be pushed to the npm registry.

    Contributing

    Have a bug? File an issue with a simple example that reproduces this so we can take a look & confirm.

    Want to make a change? Submit a PR, explain why it's useful, and make sure you've updated the docs (this file) and the tests (see test folder).

    License

    This project is licensed under Apache 2 - see the LICENSE file for details

    Keywords

    none

    Install

    npm i @ovotech/json-refs

    DownloadsWeekly Downloads

    9

    Version

    0.3.2

    License

    Apache-2.0

    Unpacked Size

    15.7 kB

    Total Files

    11

    Last publish

    Collaborators

    • rtsarykcorgi
    • ylukomskyi-corgi
    • david.regula.ovo
    • vitalii_khudenko
    • samuelnyamukapa
    • ishanfernando-ovo
    • radhika-bijibilla
    • mbartish-ovo
    • kaluzajianzu
    • a.skomarovskyi
    • grahamdawson-ovo
    • pkari
    • srinivasdudam2
    • shatchardovo
    • tigrago
    • ronald.nsabiyera
    • marcopie_at_kaluza
    • clueless_benefactee
    • michaelwheeler
    • prtn-ovo
    • rafolo78
    • tc-kaluza
    • lutza
    • dmytro.kubatko
    • bucabug
    • thomas.finch
    • v.kolesnyk
    • mykola.p
    • s.slotskyi-ovo
    • hantastico
    • joemaher
    • tanjil-hussain
    • adam.vile
    • raluza
    • ipa-bot
    • luigi94
    • anthony_tonev
    • simonarcher999
    • dominicboston-kaluza
    • iblamefish
    • robert-smith-01
    • katebee-kaluza
    • gideoncaspi
    • coderdanuk
    • kawbot
    • markberesford301
    • ovo-homeplan
    • rupson
    • oeptariffs
    • tony.ross
    • bvjones
    • data.discovery.ovo
    • ralitsa
    • fraserhamiltonovo
    • accrecovo
    • luigi.riefolo
    • andy-heywood-ovo
    • rmcnovo
    • ggerikp
    • xnejp03
    • emmapr123
    • andrew-brook-rad
    • a.calderwood
    • sulgee.kim
    • sseccombe
    • samcooper720x
    • lughino
    • amayuk
    • jagreenwood1
    • radek_tomasek
    • clarencedglee
    • ovocms
    • ovotech-sme-team
    • gjain-npm-ovo
    • kenneth-gray
    • nevenablagoeva
    • pete-woodland
    • orion-migration-team
    • ovotech-sg
    • chanex
    • ovotech-qs
    • ovotech-paym
    • ovotech-payments
    • ovotech-live
    • ovotech-payg
    • freddybushboy
    • sarahlikeshiny
    • ovotech-boost
    • agaovo
    • filose
    • props
    • yesdaveovo
    • rob-ovo
    • ellafutkowska
    • ikerin
    • mwidurek
    • andreaborsos
    • tomshawovo
    • ovotech-identity
    • iuna4e
    • lcatallo
    • orex-team
    • ahvargas
    • cwkaluza
    • smart-heat-uat
    • smart-heat-prod
    • potsec
    • rosario-ovo
    • tech.international
    • jvmovo
    • boost-smile
    • nicolasov
    • ovo.cms.devs
    • mkohlmyr
    • sketchingdev
    • mrkiplin
    • ovo-devices
    • sophiepoole
    • joepurnell-ovo
    • vkobyletskyi_ovo
    • richardday-ovo
    • rparkhomchuk
    • daumenta
    • benoitovo
    • v.vasylets
    • enza252
    • lewisunsworthkaluza
    • t.vytrykush
    • vslepkan
    • jubril
    • petro.shevchuk.corgi
    • melcbuckov
    • kir_exp
    • zyurii
    • vlavrynenko-nix
    • timmy.antonio
    • brettburman-code
    • vzahakailo
    • petro.pavlenko
    • goncalogarcia
    • chris.dickson.kaluza
    • muigui
    • k-fernandez
    • alonabarabash
    • manojkakarla
    • nelsma
    • jadamiec-ovo
    • georgi.krastev
    • marknreynolds
    • m_heald
    • gregshielkaluza
    • gordonmartin
    • ovo-data-science-engineering-bot
    • jonnyleakaluza
    • stephen.harris
    • alex-wilson-ovo
    • scdf
    • xenjke
    • rob.straughan
    • molbalazs
    • joewhittles
    • sampennington64
    • marcusgriff
    • amelia.ovo
    • juliabutterly
    • chris.smith
    • sophiesillmanovo
    • marcesquerra
    • pedoublety
    • ovo-engagement
    • marcuskielly
    • david.chellapah.ovo
    • kupxc
    • harrisonbaxter
    • apjm
    • shnist
    • mikemchugh
    • sarahbeharry
    • ursularodgers
    • inlustra
    • andrewjtn
    • tarlingovo
    • troyb95
    • david.ovo
    • ovoenergyapps
    • marina-ovo
    • tom-g-dane
    • homemoves
    • samwest
    • sophiefield
    • simonmclean-ovo
    • jamesbaum
    • robert-g-j
    • paceteamkaluza
    • ovo-oot-bot
    • stuharv-ovo
    • eddiec86
    • csherwin
    • g-tibbs
    • puzzledbytheweb
    • lewright
    • pedro.caldeira
    • aidenscott2016
    • keirlawson
    • dwfullerton
    • gordok
    • darrenthomas-sse
    • seagullmouse
    • markwood23
    • timsteeleovo
    • jacktreble
    • gordon-rennie-ovo
    • adam-mcdevitt
    • jkiely
    • ovo-dc
    • orion-digital-support-experience
    • ovotech-smart-thermostat
    • yahmad
    • kelemensanyi
    • wtaylor-ovo
    • jrdavenport
    • dleyland-ovo
    • rob.desbois
    • sicrossley
    • lewisdick-ovo
    • sjmann
    • stevemossovo
    • eduardolaranjo
    • unibozu
    • cp-ui-tooling
    • lenardprattovo
    • dieman89
    • jensraaby-ovo
    • anthonysmithovo
    • tom.sherman
    • tomlloyd
    • matyas-ovo
    • jamesnoble1
    • phil-pinkowski
    • ovo-aarongibbison
    • nebuladesignsystem
    • ovo-matt-hodges
    • luke-adams-ovo
    • j_kapella
    • mike.walters
    • bgzstephen
    • matthewbursteinovo
    • kslat3r
    • mtardugno-ovo
    • zoelanham
    • jchoskins
    • tom.mottram.kaluza
    • ewan-m
    • mishabruml
    • maciek-kaluza
    • vmary
    • mugishau
    • peterh-ovo
    • dvidg
    • nickfitton-ovo
    • dave.allison
    • oep-accounts-bot
    • cbousie
    • j.okeefe
    • ursula_rodgers
    • jgarciapaj
    • petegrace
    • retrojetpacks
    • benaston13
    • ovo-bit-tech
    • fulvio.ovo
    • blair.calderwood.radically
    • pedromss
    • simonlewissse
    • joolskaluza
    • jifarra-kaluza
    • jameswelshkaluza
    • kimnil
    • carolinelywood
    • mike-gregory-kaluza
    • vasil.dininski
    • sir_hiss
    • csillabarna
    • luca.sale
    • friendigo
    • oroberts221
    • pedro.costa.kaluza
    • annebeth-ovo
    • quartin
    • georgexcollins
    • kapikaluza
    • iovana.pavlovici
    • filosganga
    • chris.brindley
    • engagement-insights
    • hentielouw
    • jaws-bot
    • leaski
    • elliekempster91
    • zoejm
    • rekaelek-ovo
    • nathanmarshovo
    • robturnerovo
    • dsingh07
    • ovo-james
    • jthomasovo