superfly-timeline - npm Package Compare versions

Comparing version 0.1.1 to 2.0.2

package.json

 {
   "name": "superfly-timeline",
-  "version": "0.1.1",
+  "version": "2.0.2",
   "description": "A collection of rules as well as a resolver for placing objects on a virtual timeline.",
   "license": "MIT",
-  "author": { 
-    "name" : "Johan Nyman", 
-    "email" : "[e-mail]"
+  "author": {
+    "name": "Johan Nyman",
+    "email": "[e-mail]"
   },
+  "contributors": [
+    {
+      "name": "Stephan Nordnes Eriksen",
+      "email": "[e-mail]"
+    }
+  ],
   "homepage": "http://superfly.tv",
@@ -15,13 +21,96 @@ "repository": {
   },
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
   "bugs": {
     "url": "https://github.com/SuperFlyTV/supertimeline/issues"
   },
-  "main": "index.js",
-  "scripts": { 
-    "test": "node test.js"
+  "scripts": {
+    "info": "npm-scripts-info",
+    "build": "trash dist && yarn build:main",
+    "build:main": "tsc -p tsconfig.json",
+    "lint": "tslint --project tsconfig.jest.json --config tslint.json",
+    "unit": "jest --forceExit --detectOpenHandles",
+    "test": "yarn lint && yarn unit",
+    "test:integration": "yarn lint && jest --config=jest-integration.config.js",
+    "watch": "jest --watch",
+    "cov": "jest --coverage; opn coverage/lcov-report/index.html",
+    "cov-open": "opn coverage/lcov-report/index.html",
+    "send-coverage": "jest && codecov",
+    "docs": "yarn docs:html && opn docs/index.html",
+    "docs:test": "yarn docs:html",
+    "docs:html": "typedoc src/index.ts --excludePrivate --mode file --theme minimal --out docs",
+    "docs:json": "typedoc --mode file --json docs/typedoc.json src/index.ts",
+    "docs:publish": "yarn docs:html && gh-pages -d docs",
+    "changelog": "standard-version",
+    "release": "yarn reset && yarn test && yarn docs:publish && yarn changelog",
+    "reset": "git clean -dfx && git reset --hard && yarn",
+    "ci": "yarn test && yarn docs:test",
+    "validate:dependencies": "nsp check && yarn license-validate",
+    "license-validate": "node-license-validator -p -d --allow-licenses MIT BSD BSD-3-Clause ISC Apache"
   },
+  "scripts-info": {
+    "info": "Display information about the scripts",
+    "build": "(Trash and re)build the library",
+    "build:main": "Builds main build command without trash.",
+    "lint": "Lint all typescript source files",
+    "unit": "Build the library and run unit tests",
+    "test": "Lint, build, and test the library",
+    "test:integration": "Integration tests. Work in progress",
+    "watch": "Watch source files, rebuild library on changes, rerun relevant tests",
+    "cov": "Run tests, generate the HTML coverage report, and open it in a browser",
+    "cov-open": "Open current test coverage",
+    "send-coverage": "send coverage to codecov",
+    "docs": "Generate HTML API documentation and open it in a browser",
+    "docs:test": "Running the docs generation for testing.",
+    "docs:html": "Generate HTML documentation",
+    "docs:json": "Generate API documentation in typedoc JSON format",
+    "docs:publish": "Generate HTML API documentation and push it to GitHub Pages",
+    "changelog": "Bump package.json version, update CHANGELOG.md, tag a release",
+    "release": "Clean, build, test, publish docs, and prepare release (a one-step publish process). Updates versions and creates git commits.",
+    "reset": "Delete all untracked files and reset the repo to the last commit",
+    "ci": "Test script for running by the CI (CircleCI)",
+    "validate:dependencies": "Scan dependencies for vulnerabilities and check licenses",
+    "license-validate": "Validate licenses for dependencies."
+  },
+  "engines": {
+    "node": ">=4.5"
+  },
+  "devDependencies": {
+    "@types/jest": "^23.0.0",
+    "@types/node": "^8.0.4",
+    "codecov": "^3.0.2",
+    "cpx": "^1.5.0",
+    "fast-clone": "^1.5.3",
+    "gh-pages": "^1.2.0",
+    "jest": "^23.1.0",
+    "mkdirp": "^0.5.1",
+    "node-license-validator": "^1.3.0",
+    "npm-scripts-info": "^0.3.7",
+    "nsp": "^3.2.1",
+    "nyc": "^12.0.2",
+    "opn-cli": "^3.1.0",
+    "sleep-ms": "^2.0.1",
+    "standard-version": "^4.4.0",
+    "trash-cli": "^1.4.0",
+    "ts-jest": "^22.4.6",
+    "tslint": "^5.10.0",
+    "tslint-config-standard": "^7.0.0",
+    "typedoc": "^0.11.1",
+    "typescript": "^2.9.1"
+  },
+  "keywords": [
+    "broadcast",
+    "typescript",
+    "javascript",
+    "open",
+    "source"
+  ],
   "dependencies": {
-    "underscore": "^1.8.3",
-    "fast-clone": "^1.4.2"
+    "@types/underscore": "^1.8.8",
+    "underscore": "^1.9.1"
+  },
+  "standard-version": {
+    "message": "chore(release): %s [skip ci]",
+    "tagPrefix": ""
   }
 }

README.md

@@ -1,9 +0,8 @@
-# Timeline
+# SuperFly-Timeline
+[![CircleCI](https://circleci.com/gh/SuperFlyTV/supertimeline.svg?style=svg)](https://circleci.com/gh/SuperFlyTV/supertimeline)
 
-The Timeline is a collection of rules as well as a resolver for placing objects on a virtual timeline. It uses the concept of timing objects in sequences – absolute or relative timings – which resolves recursively in nested structures. This means it supports grouping, combinations of timing between groups, and objects within groups. It also supports logical conditions instead of timed conditions.
+The SuperFly-Timeline is a collection of rules as well as a resolver for placing objects on a virtual timeline. It uses the concept of timing objects in sequences -– absolute or relative timings -– which resolves recursively in nested structures. This means it supports grouping, combinations of timing between groups, and objects within groups. It also supports logical conditions instead of timed conditions.
 
 Licence: MIT
 
-*Note: This documentation is a work-in-progress!*
-
 ## Installation
@@ -20,3 +19,3 @@ ### NodeJS
 ```javascript
-var SuperTimeline = require("superfly-timeline");
+var Timeline = require("superfly-timeline");
 
@@ -31,3 +30,3 @@ // The input to the timeline is an array of objects
 	trigger: {
-		type: SuperTimeline.enums.TriggerType.TIME_ABSOLUTE, 
+		type: Timeline.enums.TriggerType.TIME_ABSOLUTE, 
 		value: Date.now()/1000 - 10 // 10 seconds ago
@@ -44,3 +43,3 @@ },
 	trigger: {
-		type: SuperTimeline.enums.TriggerType.TIME_RELATIVE, 
+		type: Timeline.enums.TriggerType.TIME_RELATIVE, 
 		value: '#obj0.end'
@@ -53,6 +52,6 @@ },
 // By resolving the timeline, the times of the objects are calculated:
-var tl = SuperTimeline.resolver.getTimelineInWindow(myObjects);
+var tl = Timeline.resolver.getTimelineInWindow(myObjects);
 
 // To see whats on right now, we fetch the State:
-var stateNow = SuperTimeline.resolver.getState(tl, Date.now()/1000);
+var stateNow = Timeline.resolver.getState(tl, Date.now()/1000);
 //
@@ -85,3 +84,3 @@ /*
 // To see what will be on in a minute, we fetch the state for that time:
-var stateInAMinute = SuperTimeline.resolver.getState(tl, Date.now()/1000 + 60);
+var stateInAMinute = Timeline.resolver.getState(tl, Date.now()/1000 + 60);
 /*
@@ -118,3 +117,3 @@ stateNow = {
 * **Absolute time** (TIME_ABSOLUTE)
-	The start time of the object is defined as a number (unix time).
+	The start time of the object is defined as a float number (unix time).
 
@@ -124,3 +123,3 @@ * **Relative time** (TIME_RELATIVE)
     
-	Exmples:
+	Examples:
     
@@ -181,3 +180,3 @@ **"#obj0.end"** The end time of another object
 * **Graphical layer** (GLayer):
-	The difference between GLayers & LLayers are that while LLayers are used first to find out WHAT to play, WHERE to play it is defined by GLayers. **(For most applications, these two will allways be the same.)**
+	The difference between GLayers & LLayers are that while LLayers are used first to find out WHAT to play, WHERE to play it is defined by GLayers. **(For most applications, these two will always be the same.)**
 
@@ -210,3 +209,3 @@ ## Object reference
 	trigger: {
-		type: SuperTimeline.enums.TriggerType.TIME_ABSOLUTE, 
+		type: Timeline.enums.TriggerType.TIME_ABSOLUTE, 
 		value: 1000,
@@ -227,3 +226,3 @@ },
 				trigger: {
-					type: SuperTimeline.enums.TriggerType.TIME_ABSOLUTE,
+					type: Timeline.enums.TriggerType.TIME_ABSOLUTE,
 					value: 5 // Abslute time means "relative to parent start time" for a keyframe
@@ -230,0 +229,0 @@ },

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

169070

increased by147.5%

Number of package files

13

increased by44.44%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

21

increased byInfinity%

Lines of code

1691

decreased by-7.24%

Number of lines in readme file

266

decreased by-0.37%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Added@types/underscore@^1.8.8

• + Added@types/underscore@1.13.0(transitive)

• - Removedfast-clone@^1.4.2

• - Removedfast-clone@1.5.13(transitive)

• Updatedunderscore@^1.9.1