chore(all): prepare-release 1.0.0-beta.1

aurelia · Nov 16, 2015 · bec47fd · bec47fd
1 parent c427a8b
commit bec47fd
Show file tree

Hide file tree

Showing 12 changed files with 2,023 additions and 1,378 deletions.
diff --git a/bower.json b/bower.json
@@ -1,6 +1,6 @@
 {
   "name": "aurelia-templating",
-  "version": "0.17.5",
+  "version": "1.0.0-beta.1",
   "description": "An extensible HTML templating engine supporting databinding, custom elements, attached behaviors and more.",
   "keywords": [
     "aurelia",
@@ -19,14 +19,14 @@
     "url": "http://github.com/aurelia/templating"
   },
   "dependencies": {
-    "aurelia-binding": "^0.11.0",
-    "aurelia-dependency-injection": "^0.12.0",
-    "aurelia-loader": "^0.11.0",
-    "aurelia-logging": "^0.9.0",
-    "aurelia-metadata": "^0.10.0",
-    "aurelia-pal": "^0.3.0",
-    "aurelia-path": "^0.11.0",
-    "aurelia-task-queue": "^0.9.0",
+    "aurelia-binding": "^1.0.0-beta.1",
+    "aurelia-dependency-injection": "^1.0.0-beta.1",
+    "aurelia-loader": "^1.0.0-beta.1",
+    "aurelia-logging": "^1.0.0-beta.1",
+    "aurelia-metadata": "^1.0.0-beta.1",
+    "aurelia-pal": "^1.0.0-beta.1",
+    "aurelia-path": "^1.0.0-beta.1",
+    "aurelia-task-queue": "^1.0.0-beta.1",
     "core-js": "zloirock/core-js"
   }
 }
diff --git a/build/tasks/doc.js b/build/tasks/doc.js
@@ -5,7 +5,7 @@ var typedocExtractor = require('gulp-typedoc-extractor');
 var runSequence = require('run-sequence');
 
 gulp.task('doc-generate', function(){
-  return gulp.src([paths.output + '*.d.ts', paths.doc + '/core-js.d.ts', './jspm_packages/github/aurelia/*/*.d.ts'])
+  return gulp.src([paths.output + '*.d.ts', paths.doc + '/core-js.d.ts', './jspm_packages/npm/*/*.d.ts'])
     .pipe(typedoc({
       target: 'es6',
       includeDeclarations: true,
@@ -30,4 +30,4 @@ gulp.task('doc', function(callback){
     'doc-extract',
     callback
   );
-});
+});
diff --git a/build/tasks/test.js b/build/tasks/test.js
@@ -1,30 +1,30 @@
 var gulp = require('gulp');
-var karma = require('karma').server;
+var Karma = require('karma').Server;
 
 /**
  * Run test once and exit
  */
 gulp.task('test', function (done) {
-    karma.start({
-        configFile: __dirname + '/../../karma.conf.js',
-        singleRun: true
-    }, done);
+  new Karma({
+    configFile: __dirname + '/../../karma.conf.js',
+    singleRun: true
+  }, done).start();
 });
 
 /**
  * Watch for file changes and re-run tests on each change
  */
 gulp.task('tdd', function (done) {
-    karma.start({
-        configFile: __dirname + '/../../karma.conf.js'
-    }, done);
+  new Karma({
+    configFile: __dirname + '/../../karma.conf.js'
+  }, done).start();
 });
 
 /**
  * Run test once with code coverage and exit
  */
 gulp.task('cover', function (done) {
-  karma.start({
+  new Karma({
     configFile: __dirname + '/../../karma.conf.js',
     singleRun: true,
     reporters: ['coverage'],
@@ -36,5 +36,5 @@ gulp.task('cover', function (done) {
       type: 'html',
       dir: 'build/reports/coverage'
     }
-  }, done);
+  }, done).start();
 });
diff --git a/config.js b/config.js
@@ -14,44 +14,18 @@ System.config({
   },
 
   map: {
-    "aurelia-binding": "github:aurelia/binding@0.11.0",
-    "aurelia-dependency-injection": "github:aurelia/dependency-injection@0.12.0",
-    "aurelia-loader": "github:aurelia/loader@0.11.0",
-    "aurelia-logging": "github:aurelia/logging@0.9.0",
-    "aurelia-metadata": "github:aurelia/metadata@0.10.0",
-    "aurelia-pal": "github:aurelia/pal@0.3.0",
-    "aurelia-pal-browser": "github:aurelia/pal-browser@0.3.0",
-    "aurelia-path": "github:aurelia/path@0.11.0",
-    "aurelia-task-queue": "github:aurelia/task-queue@0.9.0",
+    "aurelia-binding": "npm:aurelia-binding@1.0.0-beta.1",
+    "aurelia-dependency-injection": "npm:aurelia-dependency-injection@1.0.0-beta.1",
+    "aurelia-loader": "npm:aurelia-loader@1.0.0-beta.1",
+    "aurelia-logging": "npm:aurelia-logging@1.0.0-beta.1",
+    "aurelia-metadata": "npm:aurelia-metadata@1.0.0-beta.1",
+    "aurelia-pal": "npm:aurelia-pal@1.0.0-beta.1",
+    "aurelia-pal-browser": "npm:aurelia-pal-browser@1.0.0-beta.1",
+    "aurelia-path": "npm:aurelia-path@1.0.0-beta.1",
+    "aurelia-task-queue": "npm:aurelia-task-queue@1.0.0-beta.1",
     "babel": "npm:[email protected]",
     "babel-runtime": "npm:[email protected]",
     "core-js": "npm:[email protected]",
-    "github:aurelia/[email protected]": {
-      "aurelia-metadata": "github:aurelia/[email protected]",
-      "aurelia-pal": "github:aurelia/[email protected]",
-      "aurelia-task-queue": "github:aurelia/[email protected]",
-      "core-js": "npm:[email protected]"
-    },
-    "github:aurelia/[email protected]": {
-      "aurelia-logging": "github:aurelia/[email protected]",
-      "aurelia-metadata": "github:aurelia/[email protected]",
-      "aurelia-pal": "github:aurelia/[email protected]",
-      "core-js": "npm:[email protected]"
-    },
-    "github:aurelia/[email protected]": {
-      "aurelia-metadata": "github:aurelia/[email protected]",
-      "aurelia-path": "github:aurelia/[email protected]"
-    },
-    "github:aurelia/[email protected]": {
-      "aurelia-pal": "github:aurelia/[email protected]",
-      "core-js": "npm:[email protected]"
-    },
-    "github:aurelia/[email protected]": {
-      "aurelia-pal": "github:aurelia/[email protected]"
-    },
-    "github:aurelia/[email protected]": {
-      "aurelia-pal": "github:aurelia/[email protected]"
-    },
     "github:jspm/[email protected]": {
       "assert": "npm:[email protected]"
     },
@@ -67,6 +41,32 @@ System.config({
     "npm:[email protected]": {
       "util": "npm:[email protected]"
     },
+    "npm:[email protected]": {
+      "aurelia-metadata": "npm:[email protected]",
+      "aurelia-pal": "npm:[email protected]",
+      "aurelia-task-queue": "npm:[email protected]",
+      "core-js": "npm:[email protected]"
+    },
+    "npm:[email protected]": {
+      "aurelia-logging": "npm:[email protected]",
+      "aurelia-metadata": "npm:[email protected]",
+      "aurelia-pal": "npm:[email protected]",
+      "core-js": "npm:[email protected]"
+    },
+    "npm:[email protected]": {
+      "aurelia-metadata": "npm:[email protected]",
+      "aurelia-path": "npm:[email protected]"
+    },
+    "npm:[email protected]": {
+      "aurelia-pal": "npm:[email protected]",
+      "core-js": "npm:[email protected]"
+    },
+    "npm:[email protected]": {
+      "aurelia-pal": "npm:[email protected]"
+    },
+    "npm:[email protected]": {
+      "aurelia-pal": "npm:[email protected]"
+    },
     "npm:[email protected]": {
       "fs": "github:jspm/[email protected]",
       "path": "github:jspm/[email protected]",

diff --git a/dist/amd/aurelia-templating.d.ts b/dist/amd/aurelia-templating.d.ts
@@ -29,26 +29,77 @@ declare module 'aurelia-templating' {
   * Implemented by classes that describe how a view factory should be loaded.
   */
   export interface ViewStrategy {
+
+    /**
+      * Loads a view factory.
+      * @param viewEngine The view engine to use during the load process.
+      * @param compileInstruction Additional instructions to use during compilation of the view.
+      * @param loadContext The loading context used for loading all resources and dependencies.
+      * @return A promise for the view factory that is produced by this strategy.
+      */
     loadViewFactory(viewEngine: ViewEngine, compileInstruction: ViewCompileInstruction, loadContext?: ResourceLoadContext): Promise<ViewFactory>;
   }
 
   /**
   * View engine hooks that enable a view resource to provide custom processing during the compilation or creation of a view.
   */
   export interface ViewEngineHooks {
-    beforeCompile(content: DocumentFragment, resources: ViewResources, instruction: ViewCompileInstruction): void;
-    afterCompile(viewFactory: ViewFactory): void;
-    beforeCreate(viewFactory: ViewFactory, container: Container, content: DocumentFragment, instruction: ViewCreateInstruction): void;
-    afterCreate(view: View): void;
+
+    /**
+      * Invoked before a template is compiled.
+      * @param content The DocumentFragment to compile.
+      * @param resources The resources to compile the view against.
+      * @param instruction The compilation instruction associated with the compilation process.
+      */
+    beforeCompile?: (content: DocumentFragment, resources: ViewResources, instruction: ViewCompileInstruction) => void;
+
+    /**
+      * Invoked after a template is compiled.
+      * @param viewFactory The view factory that was produced from the compilation process.
+      */
+    afterCompile?: (viewFactory: ViewFactory) => void;
+
+    /**
+      * Invoked before a view is created.
+      * @param viewFactory The view factory that will be used to create the view.
+      * @param container The DI container used during view creation.
+      * @param content The cloned document fragment representing the view.
+      * @param instruction The view creation instruction associated with this creation process.
+      */
+    beforeCreate?: (viewFactory: ViewFactory, container: Container, content: DocumentFragment, instruction: ViewCreateInstruction) => void;
+
+    /**
+      * Invoked after a view is created.
+      * @param view The view that was created by the factory.
+      */
+    afterCreate?: (view: View) => void;
   }
 
   /**
   * Represents a node in the view hierarchy.
   */
   export interface ViewNode {
+
+    /**
+      * Binds the node and it's children.
+      * @param bindingContext The binding context to bind to.
+      * @param overrideContext A secondary binding context that can override the standard context.
+      */
     bind(bindingContext: Object, overrideContext?: Object): void;
+
+    /**
+      * Triggers the attach for the node and its children.
+      */
     attached(): void;
+
+    /**
+      * Triggers the detach for the node and its children.
+      */
     detached(): void;
+
+    /**
+      * Unbinds the node and its children.
+      */
     unbind(): void;
   }
 
@@ -356,6 +407,10 @@ declare module 'aurelia-templating' {
   * Decorator: Indicates that the decorated class/object is a view strategy.
   */
   export const viewStrategy: Function;
+
+  /**
+  * A view strategy that loads a view relative to its associated view-model.
+  */
   export class RelativeViewStrategy {
 
     /**
@@ -379,6 +434,10 @@ declare module 'aurelia-templating' {
       */
     makeRelativeTo(file: string): void;
   }
+
+  /**
+  * A view strategy based on naming conventions.
+  */
   export class ConventionalViewStrategy {
 
     /**
@@ -397,6 +456,11 @@ declare module 'aurelia-templating' {
       */
     loadViewFactory(viewEngine: ViewEngine, compileInstruction: ViewCompileInstruction, loadContext?: ResourceLoadContext): Promise<ViewFactory>;
   }
+
+  /**
+  * A view strategy that indicates that the component has no view that the templating engine needs to manage.
+  * Typically used when the component author wishes to take over fine-grained rendering control.
+  */
   export class NoViewStrategy {
 
     /**
@@ -408,6 +472,10 @@ declare module 'aurelia-templating' {
       */
     loadViewFactory(viewEngine: ViewEngine, compileInstruction: ViewCompileInstruction, loadContext?: ResourceLoadContext): Promise<ViewFactory>;
   }
+
+  /**
+  * A view strategy created directly from the template registry entry.
+  */
   export class TemplateRegistryViewStrategy {
 
     /**
@@ -426,6 +494,10 @@ declare module 'aurelia-templating' {
       */
     loadViewFactory(viewEngine: ViewEngine, compileInstruction: ViewCompileInstruction, loadContext?: ResourceLoadContext): Promise<ViewFactory>;
   }
+
+  /**
+  * A view strategy that allows the component authore to inline the html for the view.
+  */
   export class InlineViewStrategy {
 
     /**
@@ -865,6 +937,10 @@ declare module 'aurelia-templating' {
       */
     create(container: Container, createInstruction?: ViewCreateInstruction, element?: Element): View;
   }
+
+  /**
+  * Compiles html templates, dom fragments and strings into ViewFactory instances, capable of instantiating Views.
+  */
   export class ViewCompiler {
 
     /**
@@ -986,6 +1062,10 @@ declare module 'aurelia-templating' {
     getCachedView(): View;
     returnViewToCache(view: View): void;
   }
+
+  /**
+  * Controls the view resource loading pipeline.
+  */
   export class ViewEngine {
 
     /**
@@ -1105,6 +1185,10 @@ declare module 'aurelia-templating' {
       */
     detached(): void;
   }
+
+  /**
+  * An implementation of Aurelia's Observer interface that is used to back bindable properties defined on a behavior.
+  */
   export class BehaviorPropertyObserver {
 
     /**
@@ -1277,6 +1361,10 @@ declare module 'aurelia-templating' {
     onAdd(element: any): any;
     unbind(): any;
   }
+
+  /**
+  * Used to dynamically compose components.
+  */
   export class CompositionEngine {
 
     /**
@@ -1438,6 +1526,10 @@ declare module 'aurelia-templating' {
   * to the EventManager for one or more Web Components.
   */
   export function elementConfig(target?: any): any;
+
+  /**
+  * A facade of the templating engine capabilties which provides a more user friendly API for common use cases.
+  */
   export class TemplatingEngine {
 
     /**