@dcl/schemas 5.0.3 → 5.0.4

package/README.md

@@ -1,19 +1,34 @@
 # common-schemas
 
+Decentraland data structure interfaces and validators for TypeScript-based projects.
+
+Install it with:
 ```bash
 npm i @dcl/schemas
 ```
 
-### Design considerations
+## Design Guidelines
+
+- Prevent type problems across projects
+- Fail as early as possible, aim for compile-time
+- Preserve user optionality through runtime helpers
+- Prefer no-cost implementations and allow no-dependency import
+- Code is written once, read hundreds of times
 
-- The main entrypoint of the library export types only (and the helper functions to prevent lockin)
+Implementation decisions:
+
+- The main entrypoint should only export types
 - Every type is also a namespace
 - Type names are PascalCase
 - Validators and schemas are camelCase
 
-## Generating types, validators and schemas
+### Collaborator's Guide
+
+#### Generating types, validators and schemas
 
-We will export types that also act as values. We do that using the "namespaces" of typescript. That is, every type is also a JS object, including two properties: `schema` and `validate`. It can also be a const, but a namespace _sounds_ better.
+This library export types that also act as values. This is achieved through TypeScript's [`namespaces`](https://www.typescriptlang.org/docs/handbook/namespaces.html). This means that every type imported from this library can also be used as a JS object. These types will include two properties named `schema` and `validate`. `namespaces` in typescript can be considered "`cost` imports".
+
+#### Example Type Definition
 
 ```ts
 // Declare type
@@ -36,12 +51,11 @@ export namespace MyType {
 }
 ```
 
-In that sense, MyType can be both used as type `const a: MyType` and as object `MyType.validate(a)`.
+MyType can now be both used as type `const a: MyType` or as an object `MyType.validate(a)`.
 
-Beware that `validate` has type `ValidateFunction<T>` which `ajv` creates automatically. When writing new
-validations always try to implement it as an ajv validation, even if custom code is needed. See [here](https://ajv.js.org/keywords.html#define-keyword-with-code-generation-function).
+Beware that `validate` has type `ValidateFunction<T>` which `ajv` creates automatically. When writing new validations always try to implement it as an ajv validation, even if custom code is needed. See [here](https://ajv.js.org/keywords.html#define-keyword-with-code-generation-function).
 
-In particular, don't fall in the trap of doing this:
+Particularly, beware of using the library like this, because reports by the `validator.validate` function are lost and never returned to the caller.
 
 ```ts
 const validator = generateValidator<MyType>(schema);
@@ -49,28 +63,23 @@ export const validate = (mt: MyType) =>
   validator.validate(mt) && otherValidations(mt);
 ```
 
-By doing this, all the errors reported by the `validator.validate` function are lost and never returned
-to the caller.
-
-## Type ownership
+#### Code ownership
 
 Please add types and schemas of your domain into the `src/<team>` folder, also add your team to the [CODEOWNERS](.github/CODEOWNERS) repository to make sure nobody accidentally changes it without your team noticing it.
 
-## Informing changes
-
-Please notify about changes to the schemas to the teams by adding the whole team (i.e. `@decentraland/dapps`) as reviewers of the pull requests.
+#### Informing changes
 
-It is recommended that if you are a stakeholder of the interoperable parts of Decentraland, you are subscribed to this repository (wathing it in the button up right).
+Please notify about changes to the schemas to relevant teams by adding the whole team (i.e. `@decentraland/dapps`) as reviewers of the pull requests.
 
-## Making changes
+It is recommended to subscribe to this repository (using the `Watch` function) if you use any internal part of the Decentraland ecosystem.
 
-To make sure everybody is aware of changes in types, we have a process of api-extraction using https://api-extractor.com. It creates [a report file](report/schemas.api.md) that should be reviewed upon every change and committed as part of the PR.
+#### Making changes
 
-To generate the file with your changes run `npm run refresh-api`.
+To make sure the relevant persons and groups are aware of changes in these types, there's an api-extraction process executed with https://api-extractor.com that creates [a report file](report/schemas.api.md) for review between commits. It gets included as part of PRs for easier read.
 
-In the CI, `npm run check-api` is executed to verify the generated file matches the exported types.
+To generate the file before submitting a PR, run `npm run refresh-api`. This is executed by the CI by runnig `npm run check-api`. It also verifies that the generated file matches the exported types.
 
-## Versions and publishing
+## Versioning and Publishing
 
 Versions are handled manually using Github releases and semver.
 

package/dist/platform/item/emote/adr74/emote-data-adr74.d.ts

@@ -5,6 +5,7 @@ export declare type EmoteDataADR74 = {
     category: EmoteCategory;
     representations: EmoteRepresentationADR74[];
     tags: string[];
+    loop: boolean;
 };
 export declare namespace EmoteDataADR74 {
     const schema: JSONSchema<EmoteDataADR74>;

package/dist/platform/item/emote/adr74/emote-data-adr74.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"emote-data-adr74.d.ts","sourceRoot":"","sources":["../../../../../src/platform/item/emote/adr74/emote-data-adr74.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAEL,UAAU,EACV,gBAAgB,EACjB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAA;AAEjE,oBAAY,cAAc,GAAG;IAC3B,QAAQ,EAAE,aAAa,CAAA;IACvB,eAAe,EAAE,wBAAwB,EAAE,CAAA;IAC3C,IAAI,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED,yBAAiB,cAAc,CAAC;IACvB,MAAM,MAAM,EAAE,UAAU,CAAC,cAAc,CAmB7C,CAAA;IAEM,MAAM,QAAQ,EAAE,gBAAgB,CAAC,cAAc,CAC3B,CAAA;CAC5B"}
+{"version":3,"file":"emote-data-adr74.d.ts","sourceRoot":"","sources":["../../../../../src/platform/item/emote/adr74/emote-data-adr74.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAEL,UAAU,EACV,gBAAgB,EACjB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAA;AAEjE,oBAAY,cAAc,GAAG;IAC3B,QAAQ,EAAE,aAAa,CAAA;IACvB,eAAe,EAAE,wBAAwB,EAAE,CAAA;IAC3C,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,IAAI,EAAE,OAAO,CAAA;CACd,CAAA;AAED,yBAAiB,cAAc,CAAC;IACvB,MAAM,MAAM,EAAE,UAAU,CAAC,cAAc,CAsB7C,CAAA;IAEM,MAAM,QAAQ,EAAE,gBAAgB,CAAC,cAAc,CAC3B,CAAA;CAC5B"}

package/dist/platform/item/emote/adr74/emote-data-adr74.js

@@ -21,9 +21,12 @@ var EmoteDataADR74;
                 items: representation_adr74_1.EmoteRepresentationADR74.schema,
                 minItems: 1
             },
-            category: emote_category_1.EmoteCategory.schema
+            category: emote_category_1.EmoteCategory.schema,
+            loop: {
+                type: 'boolean'
+            }
         },
-        required: ['category', 'tags', 'representations'],
+        required: ['category', 'tags', 'representations', 'loop'],
         additionalProperties: true
     };
     EmoteDataADR74.validate = (0, validation_1.generateValidator)(EmoteDataADR74.schema);

package/dist/platform/item/emote/adr74/emote-data-adr74.js.map

@@ -1 +1 @@
-{"version":3,"file":"emote-data-adr74.js","sourceRoot":"","sources":["../../../../../src/platform/item/emote/adr74/emote-data-adr74.ts"],"names":[],"mappings":";;;AAAA,sDAAiD;AACjD,uDAI+B;AAC/B,iEAAiE;AAQjE,IAAiB,cAAc,CAwB9B;AAxBD,WAAiB,cAAc;IAChB,qBAAM,GAA+B;QAChD,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,SAAS,EAAE,CAAC;iBACb;aACF;YACD,eAAe,EAAE;gBACf,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,+CAAwB,CAAC,MAAM;gBACtC,QAAQ,EAAE,CAAC;aACZ;YACD,QAAQ,EAAE,8BAAa,CAAC,MAAM;SAC/B;QACD,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,iBAAiB,CAAU;QAC1D,oBAAoB,EAAE,IAAI;KAC3B,CAAA;IAEY,uBAAQ,GACnB,IAAA,8BAAiB,EAAC,eAAA,MAAM,CAAC,CAAA;AAC7B,CAAC,EAxBgB,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAwB9B"}
+{"version":3,"file":"emote-data-adr74.js","sourceRoot":"","sources":["../../../../../src/platform/item/emote/adr74/emote-data-adr74.ts"],"names":[],"mappings":";;;AAAA,sDAAiD;AACjD,uDAI+B;AAC/B,iEAAiE;AASjE,IAAiB,cAAc,CA2B9B;AA3BD,WAAiB,cAAc;IAChB,qBAAM,GAA+B;QAChD,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,SAAS,EAAE,CAAC;iBACb;aACF;YACD,eAAe,EAAE;gBACf,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,+CAAwB,CAAC,MAAM;gBACtC,QAAQ,EAAE,CAAC;aACZ;YACD,QAAQ,EAAE,8BAAa,CAAC,MAAM;YAC9B,IAAI,EAAE;gBACJ,IAAI,EAAE,SAAS;aAChB;SACF;QACD,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,CAAU;QAClE,oBAAoB,EAAE,IAAI;KAC3B,CAAA;IAEY,uBAAQ,GACnB,IAAA,8BAAiB,EAAC,eAAA,MAAM,CAAC,CAAA;AAC7B,CAAC,EA3BgB,cAAc,GAAd,sBAAc,KAAd,sBAAc,QA2B9B"}

package/dist/platform/item/emote/emote-category.d.ts

@@ -1,7 +1,6 @@
 import { JSONSchema, ValidateFunction } from '../../../validation';
 export declare enum EmoteCategory {
-    SIMPLE = "simple",
-    LOOP = "loop"
+    SIMPLE = "simple"
 }
 export declare namespace EmoteCategory {
     const schema: JSONSchema<EmoteCategory>;

package/dist/platform/item/emote/emote-category.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"emote-category.d.ts","sourceRoot":"","sources":["../../../../src/platform/item/emote/emote-category.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,gBAAgB,EACjB,MAAM,qBAAqB,CAAA;AAE5B,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,IAAI,SAAS;CACd;AAED,yBAAiB,aAAa,CAAC;IACtB,MAAM,MAAM,EAAE,UAAU,CAAC,aAAa,CAG5C,CAAA;IAEM,MAAM,QAAQ,EAAE,gBAAgB,CAAC,aAAa,CAC1B,CAAA;CAC5B"}
+{"version":3,"file":"emote-category.d.ts","sourceRoot":"","sources":["../../../../src/platform/item/emote/emote-category.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,gBAAgB,EACjB,MAAM,qBAAqB,CAAA;AAE5B,oBAAY,aAAa;IACvB,MAAM,WAAW;CAClB;AAED,yBAAiB,aAAa,CAAC;IACtB,MAAM,MAAM,EAAE,UAAU,CAAC,aAAa,CAG5C,CAAA;IAEM,MAAM,QAAQ,EAAE,gBAAgB,CAAC,aAAa,CAC1B,CAAA;CAC5B"}

package/dist/platform/item/emote/emote-category.js

@@ -5,7 +5,6 @@ const validation_1 = require("../../../validation");
 var EmoteCategory;
 (function (EmoteCategory) {
     EmoteCategory["SIMPLE"] = "simple";
-    EmoteCategory["LOOP"] = "loop";
 })(EmoteCategory = exports.EmoteCategory || (exports.EmoteCategory = {}));
 (function (EmoteCategory) {
     EmoteCategory.schema = {

package/dist/platform/item/emote/emote-category.js.map

@@ -1 +1 @@
-{"version":3,"file":"emote-category.js","sourceRoot":"","sources":["../../../../src/platform/item/emote/emote-category.ts"],"names":[],"mappings":";;;AAAA,oDAI4B;AAE5B,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,8BAAa,CAAA;AACf,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAED,WAAiB,aAAa;IACf,oBAAM,GAA8B;QAC/C,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC;KACnC,CAAA;IAEY,sBAAQ,GACnB,IAAA,8BAAiB,EAAC,cAAA,MAAM,CAAC,CAAA;AAC7B,CAAC,EARgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAQ7B"}
+{"version":3,"file":"emote-category.js","sourceRoot":"","sources":["../../../../src/platform/item/emote/emote-category.ts"],"names":[],"mappings":";;;AAAA,oDAI4B;AAE5B,IAAY,aAEX;AAFD,WAAY,aAAa;IACvB,kCAAiB,CAAA;AACnB,CAAC,EAFW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAExB;AAED,WAAiB,aAAa;IACf,oBAAM,GAA8B;QAC/C,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC;KACnC,CAAA;IAEY,sBAAQ,GACnB,IAAA,8BAAiB,EAAC,cAAA,MAAM,CAAC,CAAA;AAC7B,CAAC,EARgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAQ7B"}

package/dist/platform/merkle-tree/merkle-proof.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"merkle-proof.d.ts","sourceRoot":"","sources":["../../../src/platform/merkle-tree/merkle-proof.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,gBAAgB,EACjB,MAAM,kBAAkB,CAAA;AAEzB;;;GAGG;AACH,oBAAY,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;;GAGG;AACH,yBAAiB,WAAW,CAAC;IACpB,MAAM,MAAM,EAAE,UAAU,CAAC,WAAW,CAyB1C,CAAA;IAEM,MAAM,QAAQ,EAAE,gBAAgB,CAAC,WAAW,CACxB,CAAA;CAC5B"}
+{"version":3,"file":"merkle-proof.d.ts","sourceRoot":"","sources":["../../../src/platform/merkle-tree/merkle-proof.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,gBAAgB,EACjB,MAAM,kBAAkB,CAAA;AAEzB;;;GAGG;AACH,oBAAY,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;;GAGG;AACH,yBAAiB,WAAW,CAAC;IACpB,MAAM,MAAM,EAAE,UAAU,CAAC,WAAW,CAwB1C,CAAA;IAEM,MAAM,QAAQ,EAAE,gBAAgB,CAAC,WAAW,CACxB,CAAA;CAC5B"}

package/dist/platform/merkle-tree/merkle-proof.js

@@ -15,8 +15,7 @@ var MerkleProof;
                 type: 'array',
                 items: {
                     type: 'string'
-                },
-                minItems: 1
+                }
             },
             index: {
                 type: 'number'

package/dist/platform/merkle-tree/merkle-proof.js.map

@@ -1 +1 @@
-{"version":3,"file":"merkle-proof.js","sourceRoot":"","sources":["../../../src/platform/merkle-tree/merkle-proof.ts"],"names":[],"mappings":";;;AAAA,iDAIyB;AAazB;;;GAGG;AACH,IAAiB,WAAW,CA8B3B;AA9BD,WAAiB,WAAW;IACb,kBAAM,GAA4B;QAC7C,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;iBACf;gBACD,QAAQ,EAAE,CAAC;aACZ;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;aACf;SACF;QACD,QAAQ,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC;QACzD,oBAAoB,EAAE,IAAI;KAC3B,CAAA;IAEY,oBAAQ,GACnB,IAAA,8BAAiB,EAAC,YAAA,MAAM,CAAC,CAAA;AAC7B,CAAC,EA9BgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA8B3B"}
+{"version":3,"file":"merkle-proof.js","sourceRoot":"","sources":["../../../src/platform/merkle-tree/merkle-proof.ts"],"names":[],"mappings":";;;AAAA,iDAIyB;AAazB;;;GAGG;AACH,IAAiB,WAAW,CA6B3B;AA7BD,WAAiB,WAAW;IACb,kBAAM,GAA4B;QAC7C,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;aACf;SACF;QACD,QAAQ,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC;QACzD,oBAAoB,EAAE,IAAI;KAC3B,CAAA;IAEY,oBAAQ,GACnB,IAAA,8BAAiB,EAAC,YAAA,MAAM,CAAC,CAAA;AAC7B,CAAC,EA7BgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA6B3B"}

package/dist/schemas.d.ts

@@ -469,8 +469,7 @@ declare type EmoteADR74 = BaseItem & (StandardProps | ThirdPartyProps) & {
 };
 
 export declare enum EmoteCategory {
-    SIMPLE = "simple",
-    LOOP = "loop"
+    SIMPLE = "simple"
 }
 
 export declare namespace EmoteCategory {
@@ -482,6 +481,7 @@ export declare type EmoteDataADR74 = {
     category: EmoteCategory;
     representations: EmoteRepresentationADR74[];
     tags: string[];
+    loop: boolean;
 };
 
 export declare namespace EmoteDataADR74 {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.0.3",
+  "version": "5.0.4",
   "name": "@dcl/schemas",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
@@ -32,5 +32,5 @@
   "files": [
     "dist"
   ],
-  "commit": "aecec8ee67ac77663d3b9a993ba701fbe23a9c04"
+  "commit": "df0b2795925bfd462fb4fbe0688e96db2275c7ef"
 }