@0xcert/scaffold - npm Package Compare versions

Comparing version 1.0.0-rc3 to 1.0.0-rc4

CHANGELOG.json

@@ -5,4 +5,4 @@ {
     {
-      "version": "1.0.0-rc3",
-      "tag": "@0xcert/scaffold_v1.0.0-rc3",
+      "version": "1.0.0-rc4",
+      "tag": "@0xcert/scaffold_v1.0.0-rc4",
       "date": "Thu, 22 Nov 2018 00:51:03 GMT",
@@ -9,0 +9,0 @@ "comments": {}

dist/assets/metadata.d.ts

 export interface AssetMetadata {
-    description: string;
-    image: string;
-    name: string;
+    description?: string;
+    image?: string;
+    name?: string;
 }

package.json

 {
   "name": "@0xcert/scaffold",
-  "version": "1.0.0-rc3",
+  "version": "1.0.0-rc4",
   "description": "Overarching module with types, enums, and interfaces for easier development of interoperable modules.",
@@ -69,3 +69,3 @@ "main": "./dist/index.js",
     "@hayspec/spec": "^0.8.3",
-    "@types/node": "^10.12.10",
+    "@types/node": "^10.12.24",
     "nyc": "^13.1.0",
@@ -72,0 +72,0 @@ "ts-node": "^7.0.1",

README.md

@@ -8,1 +8,7 @@ <img src="https://github.com/0xcert/framework/raw/master/assets/cover-sub.png" />
 This module is one of the bricks of the [0xcert Framework](https://docs.0xcert.org). It's written with [TypeScript](https://www.typescriptlang.org) and it's actively maintained. The source code is available on [GitHub](https://github.com/0xcert/framework) where you can also find our [issue tracker](https://github.com/0xcert/framework/issues).
+
+# Scaffold Interfaces
+
+These TypeScript interfaces are platform-agnostic base types which are implemented separately in for each provider.
+
+Or in plain English, these are the base data structures in the 0xcert protocol regardless of whether you are using it on a blockchain or MongoDB.

src/assets/metadata.ts

@@ -5,5 +5,10 @@ /**
 export interface AssetMetadata {
-  description: string;
-  image: string;
-  name: string;
+  /** A detailed description of an asset */
+  description?: string;
+
+  /** A valid URI pointing to a resource with mime type image/* representing the asset to which this NFT represents. Consider making any images at a width between 320 and 1080 pixels and aspect ratio between 1.91:1 and 4:5 inclusive. */
+  image?: string;
+
+  /** A name of an asset */
+  name?: string;
 }

src/core/provider.ts

 /**
- *
+ * A provider is a connection to a blockchain or other database store.
  */
@@ -4,0 +4,0 @@ export interface ProviderBase {

tslint.json

@@ -239,11 +239,2 @@ {
     "ban-ts-ignore": true,
-    "no-console": [
-      true,
-      "log",
-      "debug",
-      "info",
-      "time",
-      "timeEnd",
-      "trace"
-    ],
     "no-debugger": true,
@@ -250,0 +241,0 @@ "no-eval": true,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

40541

increased by36.03%

Number of package files

42

increased by7.69%

Lines of code

871

increased by1.87%

Number of lines in readme file

13

increased by62.5%

No dependency changes