anvilresearch / json-document Goto Github PK

View Code? Open in Web Editor NEW

13.0 13.0 2.0 184 KB

Fast, declarative, standards-based JavaScript (ES6) data modeling & manipulation

License: MIT License

JavaScript 100.00%

json-document's People

Contributors

Stargazers

Watchers

Forkers

sen0rxol0 kannanvm

json-document's Issues

Migration to webpack5

Please update @trust/json-document to migrate to webpack5 as maintaining it in the Debian OS environment caused a bug as we try to build the package with webpack 5.65.0, as you still support of webpack1.13.1

here is a link to the bug report https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1002865

The failing build major output looks like this while building with webpack 5.65.0

 debian/rules binary
dh binary
   dh_update_autotools_config
   dh_autoreconf
   debian/rules override_dh_auto_build
make[1]: Entering directory '/home/ayoyimika/debian-js-packaging/trust-json-document/node-trust-json-document'
babeljs --no-babelrc src -d lib --presets=@babel/preset-env
Successfully compiled 10 files with Babel (4537ms).
webpack --output-filename json-document.js --mode development
asset json-document.js 99 bytes [emitted] (name: main)

ERROR in main
Module not found: Error: Recursion in resolving
Stack:
  undefined: (/home/ayoyimika/debian-js-packaging/trust-json-document/node-trust-json-document) ./lib/index.js

webpack 5.65.0 compiled with 1 error in 191 ms
make[1]: *** [debian/rules:32: debian/js/json-document.min.js] Error 1
make[1]: Leaving directory '/home/ayoyimika/debian-js-packaging/trust-json-document/node-trust-json-document'
make: *** [debian/rules:48: binary] Error 2
dpkg-buildpackage: error: debian/rules binary subprocess returned exit status 2

A simple solution i proffer is migrating to webpack5 to have access to its updated features, benefits and options https://webpack.js.org/migrate/5/

Thanks and Cheers

Creating errors from validation results

A typical usage for json-document validation is something like in jose/JWKSet.importKeys():

if (!validation.valid) {
  return Promise.reject(validation)
}

However, Promise.reject(), just like a regular throw, is supposed to accept Error objects. For various historical reasons, throw also accepts non-error objects (so you can throw a string, ie throw 'Something'). Same with Promise.reject(). However, this is considered an anti-pattern, and Standard linters flag this as an error.

Now, a validation result is currently not an Error instance, it's its own object.

So the question before us is this: What's the best way to turn a validation result into an Error instance? I'm currently doing something like:

return Promise.reject(new Error(JSON.stringify(validation)))

but that feels hack-y. We should actually consider a .error getter method on our validation result instances. (That would return a nice error instance, populated with a stringified validation error message.) So that the use can do:

return Promise.reject(validation.error)

Remove require 'js-beautify' occurrences, or add it to package.json

There's a stray require('js-beautify') in Initializer.js (though its actual usage is commented out). Let's remove it or add that lib to package.json, cause it causes a 'cannot find module' error.

Having "type" as key name as validation property throws error

Example:
... properties: { id: { type: 'string'}, type: {type: 'string' },

Trace:

`
undefined:47
if (value !== undefined && ) {
^

SyntaxError: Unexpected token )
`

Downstream error in JOSE / importKeys()

I suspect this one has something to do with the recent changes in schema validation (I'm on json-document v0.1.1

In jose/JWKSet.js#L30 in importKeys(), I'm getting the following validation error:

{ valid: false,
  errors:
   [ { keyword: 'enum',
       message: '["verify"] is not an enumerated value' },
     { keyword: 'enum',
       message: '["verify"] is not an enumerated value' },
     { keyword: 'enum',
       message: '["verify"] is not an enumerated value' },
     { keyword: 'enum',
       message: '["verify"] is not an enumerated value' },
     { keyword: 'enum',
       message: '["verify"] is not an enumerated value' },
     { keyword: 'enum',
       message: '["verify"] is not an enumerated value' },
     { keyword: 'enum',
       message: '["verify"] is not an enumerated value' } ] }

This is what the jwks object that's being validated looks like:

{ keys:
   [ { kid: 'E0lJdnSTmYg',
       kty: 'RSA',
       alg: 'RS256',
       n: 'zXwQOoY8ITG5rpF3Sew1cKEHzmgRAA12JNS4OlFQosHO3e7NiNsHjRL8XKrsjkvaWMjmkfPEUagfMjbxgr6fNz0k2zO3F6S8loyWeO4ySc-GIVOas8SSdmTRIuHdeLyhZQicfbLZUSJOsFj7jLsf1QxDQ0ih8qqzM0L6Zud8REnh6W6i_60xxNnSm2mqgt9h9wS37kl38tGRme5xkBSKkvF-ADqBkJ7W9XcPuIVf3gkt5taVUhdgLEgG0PaJ_EffhjrgJB4YsSud0_fMqzlvMRhPSncuPTdRKd-WZEgzAycWGt5OAF3s75nBiyAdOMsTstQvM4rDFap6DdCiJPc-HQ',
       e: 'AQAB',
       key_ops: [Object],
       ext: true },
     { kid: '9fo7nRnakQ0',
       kty: 'RSA',
       alg: 'RS384',
       n: '2S-EiCzGE1tLQNUm1aKOAgCtcB_eoWHYql0AG6z7vapc2ZG8Ghw7d2QHzPbpr_Nz6eCyPSS_FHLaO_XmgfyGBaxn2SGcf_C5nJaZa7c-GLhHsFZOVN3Z4x7gF4QXB3RDmUlsAR-HMXIQgvjs5U4-oB1QIorOzGTfklYw7Cy34PoMJ_lRKA_lcdj3PolOcjeMOblCee8tp9A5smikHSXNL8J6EMSdvT6UFnilmh6uub5gCg1OlQkwOojHoWQ9zI2KtzeIb9-5VO2KvYL5VSSzZdWcCcdLBGe0of-E6BCMzL3TrnBeOEmDjC_R06PD0FLmaG35acyHCFmhrUbiuxa0mQ',
       e: 'AQAB',
       key_ops: [Object],
       ext: true },
     { kid: '39tVpuvpQPY',
       kty: 'RSA',
       alg: 'RS512',
       n: 'o6gSGgur5ewPBU1UMoe75ZhQgxCoAQ4o3INfJvL1OpJvgpW4oDW0x0MDc-_oPhRrChzX5-OCGzyXHE55CXbYxRJpyWJtrojDvzwfFhz4Ikhy_2n0M5tGUUCFJI_IQNjvNvEMoDfcZ3jRe9GVxjs_iGaUWNdMf17kIenz_mePB9PLxNjbCn7pLuegjVtokwx0j-RdvioU0JclsJX2yhUr02NUtbPoIgvIpickz3G7Ur2xoh_IeNrJDq_Sbw-A0ok4KHGnwECBLbBQIVTfCvPDksBu7fQ8DHnvZSM-IZaqnsYyhk-SsIrVe0CFUJVWKjqk7Przj6u0asaf3jWv_2jPCw',
       e: 'AQAB',
       key_ops: [Object],
       ext: true },
     { kid: 'K7zHpwgjbmk',
       kty: 'RSA',
       alg: 'RS256',
       n: 'tQTVU4B2USORRnuKuTE2qy90Pkg0IuqwEj5WqP38aBWb-GGhgLkgBvhL_LhSRYGOBdFvL3eWql4ep6doO4zqF3-Kg1uRGnkm55L9IeRlhb1vClQ9zh_osDjRjMZgFqw305EzqK0yEd-xFu3hRlW3uA9vM2Za_z31DIVeSAwdmW6_-KFKXWwM0JgAO2vp_yb5TzP-f1vzFXFZwkkAhCCA3SydZLxphHlXqbzRzjijpfabtjmSSgMqZKnkinLO6TfYDZRrSYhVpG6L5EdwyvB3sha5p55v4rQdDTwc8al-N5czTSd0FaOfFubalmXZ-tiCl3Hw3VAju9S3Jvh9BCfNgw',
       e: 'AQAB',
       key_ops: [Object],
       ext: true },
     { kid: 'fjKBx8JXLqk',
       kty: 'RSA',
       alg: 'RS384',
       n: 'sobaYwYeoNl34J0TWpssfAa_TH1cznkmQnNek9R9IRRYXyNl9uK_yuCI6-4LKMvHrbbKOa1cpj_KsZL0-FZp8A8dLhA8P3eiaPVXctpscMWUNdlNDEeqRCl8G1hXu5HC4ugY5qHIMZBCZ-pmB6MRnrQj3NZLZ-QaESVIKxoF0NuzCe_brf-FQskUBFlA8r5T5k3gkicqHD16Ab0w5gyJCWT63ELkBV6u9WmbcDVyhll-Bl4y-v1ielCgi80UonVC-ujHtRj83tJusgKEeHZSjXUnIol5taQ5Fes8E4YdFKiMjuKxKNACO4hAI-KAGjRA0DKoSkOmGzJgisIvskL4Qw',
       e: 'AQAB',
       key_ops: [Object],
       ext: true },
     { kid: 'dGQG5TrhK2w',
       kty: 'RSA',
       alg: 'RS512',
       n: 'xOCBpS4HnLJVYl_ivBp6HldBECfgWBzmGKfsZNrt7k2jj2NXoo7wB3j_-7YxjTks3Mzsoi8epGq1m8FSN8U-ovpnFPtl9tpKxYk0sZJLmZY0ftBq-dAsGF5Ksq3IIK5a3pryiOeLiDR1BVCX-pMOJMgntfQUiePlk156c6xlRkoOOWlBgNfGT_pTDMi987wkkSjRR6Mw2sRAQzen10mpfDo0kxLHkaRj0YOzYFD-2xrD0SLzgNNnyxKCudTb_49aVzDJoo1uYMpuNZB5SPDGfMgL3-7sdJ3FvBoyhEiy1va5h-7PLpzd15tC6BKwUkupfwevPMg5-81G3s3aUeAJ5Q',
       e: 'AQAB',
       key_ops: [Object],
       ext: true },
     { kid: 'T75lzOnV_Lk',
       kty: 'RSA',
       alg: 'RS256',
       n: '6j3FJiqoZWcLcEBaAF7YG7JJmueoIcZdie7R3o7wlnd-0Hk8SYrBbyEKa5fUHRZfeNnaJ-ZGgeixsBxaoASypdB89Jz1iFD_A5I9MFo3mJ7XQTCndcvE9VtrTnnqwDdV1oN1KTnIiMGZ863-D3OditNbymR3N9080D5KCtACGgeKERWGgHZ89lceAoIccHxhyxtVo6T9kZ3JWpke92nPwiGwqUYAsNtJgUauqa6BjNaoNaiJBvMCUCdwQmq6KzNPCdz_OHaLxm8M90iYEfpfZlXPMP5jDXQW4rs2-BIIArqDssrpZ-lkonjM3lXvpHJxQlZuRKarwhjLdUL-cfbxrQ',
       e: 'AQAB',
       key_ops: [Object],
       ext: true } ] }

source contains non-free licensed RFC content

The files test/JSONPatchSpec.js and test/JSONPointerSpec.js contains contents from RFC documents which are covered by licensing certainly not MIT and (by some definitions) not free.

Please consider removing that content, to ease (re)distribution e.g. by Debian-based distributions.

Implement 'case-sensitive' format

Several schemas downstream in @trust/jose are intending to use format: 'case-sensitive' property, when it becomes available.
This is a placeholder/reminder to implement support for this.

Move Patch, Pointer and Mapping to external lib(s)

If we move JSONPatch.js, JSONPointer.js and JSONMapping.js to an external lib, we will save about 15.5 kb of lib size (this is before minifying, but still).
They're being packaged up in every RP bundle, but aren't used.
Example output of a webpack command for oidc-rp:

...
  [14] ../_auth/json-document/lib/JSONPatch.js 5.21 kB {0} [built]
  [15] ../_auth/json-document/lib/JSONPointer.js 7.08 kB {0} [built]
  [16] ../_auth/json-document/lib/JSONMapping.js 3.21 kB {0} [built]
...

Array ```items``` keyword limited to single item

Given a schema:

{
  properties: {
    signatures: {
      type: 'array',
      items: { type: 'object' }
    }
  }
}

and input: { signatures: [ { foo: 'bar' }, { baz: 'qux' } ] }

results in: { signatures: [ { foo: 'bar' } ] }

Please see the @trust/model README and .editorconfig file for the proposed configuration.

Initializer not filtering out additionalProperties by default

Properties that are not defined on the schema are being allowed on the output object without explicitly stating additionalProperties: true,