etro 0.8.0 → 0.8.3

package/.github/workflows/nodejs.yml

@@ -4,7 +4,6 @@ on: [push]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
@@ -17,6 +16,9 @@ jobs:
       uses: actions/setup-node@v1
       with:
         node-version: ${{ matrix.node-version }}
+    - name: Update npm
+      run: |
+        npm i -g npm@^7.x
     - name: npm install, lint, build, and test
       run: |
         npm ci

package/.github/workflows/shipjs-trigger.yml

@@ -0,0 +1,29 @@
+name: Ship js trigger
+on:
+  pull_request:
+    types:
+      - closed
+jobs:
+  build:
+    name: Release
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true && startsWith(github.head_ref, 'releases/v')
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          ref: master
+      - uses: actions/setup-node@v1
+        with:
+          registry-url: "https://registry.npmjs.org"
+      - run: |
+          if [ -f "yarn.lock" ]; then
+            yarn install
+          else
+            npm install
+          fi
+      - run: npx shipjs trigger
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+          SLACK_INCOMING_HOOK: ${{ secrets.SLACK_INCOMING_HOOK }}

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.8.3] - 2022-01-18
+### Fixed
+- Recording not respecting the `type` option.
+- Effects throwing 'empty canvas' errors when the target's width or height is 0.
+
+## [0.8.2] - 2021-07-08
+### Fixed
+- `GaussianBlur` effect throwing a `TypeError` when applied to a movie or layer (the problem persisted).
+- Ignore layers and effects removed with `delete`.
+
+## [0.8.1] - 2021-04-20
+### Fixed
+- `sourceStartTime` getting ignored on `'movie.seek'`.
+- Calling methods like `unshift` on `Movie#layers` and `Movie#effects`.
+- `GaussianBlur` effect throwing a `TypeError` when applied to a movie or layer.
+- Issues with audio and video layers re-attaching to a movie.
+
 ## [0.8.0] - 2021-04-11
 ### Added
 - Type declarations.
@@ -136,12 +158,12 @@
 - Null or undefined layer dimensions default to the width or height of the movie.
 - Movie "end" event is now called "ended".
 
-### Fixed
-- Bug with layer options
-
 ### Removed
 - Volume, speed and muted properties. These will most likely be added as separate audio effects in the future.
 
+### Fixed
+- Bug with layer options
+
 ## [0.2.0] - 2018-10-14
 ### Added
 - Keyframes
@@ -151,7 +173,7 @@
 - Elliptical mask effect.
 - Many small improvements.
 
-## [0.1.0] - 2018-10-06
+## 0.1.0 - 2018-10-06
 ### Added
 - Movies
   - Timeline
@@ -171,12 +193,13 @@
   - Gaussian blur
   - Transform
 
-[Unreleased]: https://github.com/etro-js/etro/compare/v0.8...HEAD
-[0.8.0]: https://github.com/etro-js/etro/compare/v0.7...v0.8
-[0.7.0]: https://github.com/etro-js/etro/compare/v0.6...v0.7
-[0.6.0]: https://github.com/etro-js/etro/compare/v0.5...v0.6
-[0.5.0]: https://github.com/etro-js/etro/compare/v0.4...v0.5
-[0.4.0]: https://github.com/etro-js/etro/compare/v0.3...v0.4
-[0.3.0]: https://github.com/etro-js/etro/compare/v0.2...v0.3
-[0.2.0]: https://github.com/etro-js/etro/compare/v0.1...v0.2
-[0.1.0]: https://github.com/etro-js/etro/releases/tag/v0.1
+[0.8.3]: https://github.com/etro-js/etro/compare/v0.8.2...v0.8.3
+[0.8.2]: https://github.com/etro-js/etro/compare/v0.8.1...v0.8.2
+[0.8.1]: https://github.com/etro-js/etro/compare/v0.8.0...v0.8.1
+[0.8.0]: https://github.com/etro-js/etro/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/etro-js/etro/compare/v0.6.0...v0.7.0
+[0.6.0]: https://github.com/etro-js/etro/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/etro-js/etro/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/etro-js/etro/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/etro-js/etro/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/etro-js/etro/compare/v0.1.0...v0.2.0

package/CODE_OF_CONDUCT.md

@@ -55,11 +55,11 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting me at **\@etro-js** in the [Slack workspace]. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported by contacting me at **\@etro-js** on Twitter. All complaints will be
+reviewed and investigated and will result in a response that is deemed necessary
+and appropriate to the circumstances. The project team is obligated to maintain
+confidentiality with regard to the reporter of an incident. Further details of
+specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other

package/CONTRIBUTING.md

@@ -10,7 +10,7 @@ Thank you for considering contributing to Etro! There are many ways you can cont
 
 #### Step 0: Dependencies
 
-- You will need Git, Node, NPM and Chrome (for headless unit testing) installed
+- You will need Git, Node, NPM (at least 7.x) and Chrome (for headless unit testing) installed
 
 #### Step 1: Fork
 
@@ -22,35 +22,13 @@ Thank you for considering contributing to Etro! There are many ways you can cont
   npm install
   ```
 
-#### Step 2: Branch
-
-- To help organize your work, create a branch for your topic. Avoid working directly off the `master` branch
-
-  ```
-  git checkout -b topic-branch
-  ```
-
 ## Making your changes
 
-#### Step 3: Code
-
-- If you are writing code, please follow the style guide [StandardJS](https://standardjs.com/rules.html)
-
-- To download the example assets run
+#### Step 2: Code
 
-  ```
-  npm run assets
-  ```
-
-- Then, start the development server with
-
-  ```
-  npm start
-  ```
-
-  Now you can see your changes by running some [examples](examples).
-
-- When you're ready to submit a piece of work, first run
+- Make some changes.
+- If you are writing code, the linter uses [StandardJS](https://standardjs.com/rules.html) for style conventions.
+- When you're ready to submit a piece of code, first run
 
   ```
   npm run lint
@@ -61,13 +39,12 @@ Thank you for considering contributing to Etro! There are many ways you can cont
   to lint the code, generate the [dist](dist) files and run unit tests on them. It may be helpful to put these commands in a pre-commit hook.
 
 - Commit your changes
-  - Please avoid squashing all your commits into one; we try to keep each commit atomic in the `master` branch
+  - Please avoid squashing all your commits into one; we try to keep atomic commits.
   - Please follow these commit message guidelines:
-    - Optionally, begin each commit message with [an appropriate emoji](https://gitmoji.carloscuesta.me/)
-    - Then, write a concise summary of your changes. If you feel you need to, bullet the main idea of your changes in the description and/or explain why you made the changes.
+    - Optionally, prefix each commit message with [an appropriate emoji](https://gitmoji.dev)
     - Write in the imperative tense
-    - The first line should be 50 characters or less. Wrap lines after around 72 characters (for Vim add `filetype indent plugin on` to ~/.vimrc, and its enabled by default in Atom).
-    - *Example:*
+    - Wrap lines after 72 characters (for Vim add `filetype indent plugin on` to ~/.vimrc, it's enabled by default in Atom).
+    - Example:
 
       ```
       :emoji: One-liner
@@ -86,55 +63,32 @@ Thank you for considering contributing to Etro! There are many ways you can cont
   git rebase upstream/master
   ```
 
-- Push your changes to the topic branch in your fork of the repository
-
-  ```
-  git push origin topic-branch
-  ```
+- Push to your fork
 
 #### Step 4: Pull request
 
-- Open a pull request from your topic-branch to the main repository
+- Open a pull request from your the branch in your fork to the main repository
 - In the PR title, include **fixes ###** for bugs and **resolves ###** for feature requests
 - If you changed any core functionality, make sure you explain your motives for those changes
 
 #### Step 5: Feedback
 
-- A large part of the submission process is receiving feedback on how you can improve you pull request. If you need change your pull request,
-
-  ```
-  git add path/to/changes
-  git commit
-  git push origin topic-branch
-  ```
+- A large part of the submission process is receiving feedback on how you can improve you pull request. If you need to change your pull request, feel free to push more commits.
 
 ## Code overview
 
-*Note: To specify the ES6 module (file) that a declaration exists in, the following syntax will be used: `module.export`.*
+### Etro Overview
 
-### Module Structure
+If you are new to the core elements of etro, you should probably read [the overview guide](https://etrojs.dev/docs/overview).
 
-If you are new to the core elements of etro, you should probably read [the *Overview* wiki page](https://github.com/etro-js/etro.wiki/Overview.md).
+### API Structure
 
-Here are the contents of **src**:
-
-| Path | Contents |
-| --- | --- |
-| [**effect.js**](src/effect.js) | all (visual) effect classes |
-| [**event.js**](src/event.js) | the pub/sub mechanics |
-| [**index.js**](src/index.js) | the entry module |
-| [**layer.js**](src/layer.js) | all layer classes |
-| [**movie.js**](src/movie.js) | the `Movie` class |
-| [**util.js**](src/util.js) | general utility |
-
-Note that most of the above files will (hopefully soon) be broken down into multiple files each.
-
-### Etro Objects
-
-The base etro objects are the following:
-* `Movie` - the movie (or entire user project)
-* `layer.Base` - the root type of layer
-* `effect.Base` - the root type of visual effect
+* `etro.Movie` - the movie
+* `etro.layer.*` - all layers
+* `etro.effect.*` - all (visual) effects
+- `etro.event.publish` - emit an event
+- `etro.event.subscribe` - add an event listener
+- `etro.*` - other utility classes and methods (see **src/util.ts**)
 
 ### Etro concepts
 
@@ -151,9 +105,5 @@ That will notify all listeners of `movie` for event types `'movie'`, `'movie.typ
 ```js
 event.subscribe(movie, 'movie.type', event => {
   console.log(event.target, event.type, event.additionalData) // should print the movie, 'movie.type.of.event', 'foo'
-}
+})
 ```
-
-#### Values vs. Properties
-
-In Etro objects, almost any property can be a [keyframe](https://github.com/etro-js/etro/wiki/Keyframes), [function](https://github.com/etro-js/etro/wiki/Functions), or just a constant value. To access the current value of the property at a given time, use `util.val(property, element, time)`; where `property` is the keyframe set, function or constant value, `element` is the object to which `property` belongs, and `time` is the current time relative to the element.

package/README.md

@@ -7,10 +7,10 @@
 > Check out [this guide](https://etrojs.dev/docs/migrating-v0-8-0)
 > for migrating.
 
-Etro is a JavaScript framework for programmatically editing videos. Similar
+Etro is a typescript framework for programmatically editing videos. Similar
 to GUI-based video-editing software, it lets you layer media and other
 content on a timeline. Audio, image, video and other tracks are supported,
-along with powerful video effectts for existing tracks. Being very flexible
+along with powerful video effects for existing tracks. Being very flexible
 and extendable, you can choose to only use the core components or define your
 own.
 

package/dist/effect/base.d.ts

@@ -17,7 +17,20 @@ export declare class Base implements BaseObject {
      */
     private _occurrenceCount;
     constructor();
-    attach(target: Movie | Visual): void;
+    /**
+     * Attaches this effect to `target` if not already attached.
+     * @ignore
+     */
+    tryAttach(target: Movie | Visual): void;
+    attach(movie: Movie | Visual): void;
+    /**
+     * Dettaches this effect from its target if the number of times `tryDetach`
+     * has been called (including this call) equals the number of times
+     * `tryAttach` has been called.
+     *
+     * @ignore
+     */
+    tryDetach(): void;
     detach(): void;
     /**
      * Apply this effect to a target at the given time