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

EisenbergEffect · EisenbergEffect · commit 1bf2a5722f3a · 2015-11-15T23:59:27.000-05:00
diff --git a/bower.json b/bower.json
@@ -1,6 +1,6 @@
 {
   "name": "aurelia-metadata",
-  "version": "0.10.1",
+  "version": "1.0.0-beta.1",
   "description": "Utilities for reading and writing the metadata of JavaScript functions.",
   "keywords": [
     "aurelia",
@@ -17,7 +17,7 @@
     "url": "https://github.com/aurelia/metadata"
   },
   "dependencies": {
-    "aurelia-pal": "^0.3.0",
+    "aurelia-pal": "^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,34 +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
-    }, function(e) {
-        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'
-    }, function(e) {
-        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'],
@@ -40,7 +36,5 @@ gulp.task('cover', function (done) {
       type: 'html',
       dir: 'build/reports/coverage'
     }
-  }, function (e) {
-    done();
-  });
+  }, done).start();
 });
diff --git a/config.js b/config.js
@@ -13,7 +13,7 @@ System.config({
   },
 
   map: {
-    "aurelia-pal": "github:aurelia/pal@0.3.0",
+    "aurelia-pal": "npm:aurelia-pal@1.0.0-beta.1",
     "babel": "npm:babel-core@5.8.23",
     "babel-runtime": "npm:babel-runtime@5.8.20",
     "core-js": "npm:core-js@1.2.6",
diff --git a/dist/amd/aurelia-metadata.d.ts b/dist/amd/aurelia-metadata.d.ts
@@ -21,16 +21,52 @@ declare module 'aurelia-metadata' {
       * The metadata key representing property information.
       */
     properties: string;
+    
+    /**
+      * Gets metadata specified by a key on a target, searching up the inheritance hierarchy.
+      * @param metadataKey The key for the metadata to lookup.
+      * @param target The target to lookup the metadata on.
+      * @param targetKey The member on the target to lookup the metadata on.
+      */
     get(metadataKey: string, target: Function, targetKey: string): Object;
+    
+    /**
+      * Gets metadata specified by a key on a target, only searching the own instance.
+      * @param metadataKey The key for the metadata to lookup.
+      * @param target The target to lookup the metadata on.
+      * @param targetKey The member on the target to lookup the metadata on.
+      */
     getOwn(metadataKey: string, target: Function, targetKey: string): Object;
+    
+    /**
+      * Defines metadata specified by a key on a target.
+      * @param metadataKey The key for the metadata to define.
+      * @param target The target to set the metadata on.
+      * @param targetKey The member on the target to set the metadata on.
+      */
     define(metadataKey: string, metadataValue: Object, target: Function, targetKey: string): void;
+    
+    /**
+      * Gets metadata specified by a key on a target, or creates an instance of the specified metadata if not found.
+      * @param metadataKey The key for the metadata to lookup or create.
+      * @param Type The type of metadata to create if existing metadata is not found.
+      * @param target The target to lookup or create the metadata on.
+      * @param targetKey The member on the target to lookup or create the metadata on.
+      */
     getOrCreateOwn(metadataKey: string, Type: Function, target: Function, targetKey: string): Object;
   }
   
   /**
   * An object capable of applying it's captured decorators to a target.
   */
   export interface DecoratorApplicator {
+    
+    /**
+      * Applies the decorators to the target.
+      * @param target The target.
+      * @param key If applying to a method, the member name.
+      * @param key If applying to a method, you may supply an initial descriptor to pass to the decorators.
+      */
     on(target: any, key?: string, descriptor?: Object): any;
   }
   
@@ -54,8 +90,17 @@ declare module 'aurelia-metadata' {
   * Options used during protocol creation.
   */
   export interface ProtocolOptions {
-    validate(target: any): string | boolean;
-    compose(target: any): void;
+    
+    /**
+      * A function that will be run to validate the decorated class when the protocol is applied. It is also used to validate adhoc instances.
+      * If the validation fails, a message should be returned which directs the developer in how to address the issue.
+      */
+    validate?: (target: any) => string | boolean;
+    
+    /**
+      * A function which has the opportunity to compose additional behavior into the decorated class when the protocol is applied.
+      */
+    compose?: (target: any) => void;
   }
   
   /**
diff --git a/dist/aurelia-metadata.d.ts b/dist/aurelia-metadata.d.ts
@@ -21,16 +21,52 @@ declare module 'aurelia-metadata' {
       * The metadata key representing property information.
       */
     properties: string;
+    
+    /**
+      * Gets metadata specified by a key on a target, searching up the inheritance hierarchy.
+      * @param metadataKey The key for the metadata to lookup.
+      * @param target The target to lookup the metadata on.
+      * @param targetKey The member on the target to lookup the metadata on.
+      */
     get(metadataKey: string, target: Function, targetKey: string): Object;
+    
+    /**
+      * Gets metadata specified by a key on a target, only searching the own instance.
+      * @param metadataKey The key for the metadata to lookup.
+      * @param target The target to lookup the metadata on.
+      * @param targetKey The member on the target to lookup the metadata on.
+      */
     getOwn(metadataKey: string, target: Function, targetKey: string): Object;
+    
+    /**
+      * Defines metadata specified by a key on a target.
+      * @param metadataKey The key for the metadata to define.
+      * @param target The target to set the metadata on.
+      * @param targetKey The member on the target to set the metadata on.
+      */
     define(metadataKey: string, metadataValue: Object, target: Function, targetKey: string): void;
+    
+    /**
+      * Gets metadata specified by a key on a target, or creates an instance of the specified metadata if not found.
+      * @param metadataKey The key for the metadata to lookup or create.
+      * @param Type The type of metadata to create if existing metadata is not found.
+      * @param target The target to lookup or create the metadata on.
+      * @param targetKey The member on the target to lookup or create the metadata on.
+      */
     getOrCreateOwn(metadataKey: string, Type: Function, target: Function, targetKey: string): Object;
   }
   
   /**
   * An object capable of applying it's captured decorators to a target.
   */
   export interface DecoratorApplicator {
+    
+    /**
+      * Applies the decorators to the target.
+      * @param target The target.
+      * @param key If applying to a method, the member name.
+      * @param key If applying to a method, you may supply an initial descriptor to pass to the decorators.
+      */
     on(target: any, key?: string, descriptor?: Object): any;
   }
   
@@ -54,8 +90,17 @@ declare module 'aurelia-metadata' {
   * Options used during protocol creation.
   */
   export interface ProtocolOptions {
-    validate(target: any): string | boolean;
-    compose(target: any): void;
+    
+    /**
+      * A function that will be run to validate the decorated class when the protocol is applied. It is also used to validate adhoc instances.
+      * If the validation fails, a message should be returned which directs the developer in how to address the issue.
+      */
+    validate?: (target: any) => string | boolean;
+    
+    /**
+      * A function which has the opportunity to compose additional behavior into the decorated class when the protocol is applied.
+      */
+    compose?: (target: any) => void;
   }
   
   /**
diff --git a/dist/commonjs/aurelia-metadata.d.ts b/dist/commonjs/aurelia-metadata.d.ts
@@ -21,16 +21,52 @@ declare module 'aurelia-metadata' {
       * The metadata key representing property information.
       */
     properties: string;
+    
+    /**
+      * Gets metadata specified by a key on a target, searching up the inheritance hierarchy.
+      * @param metadataKey The key for the metadata to lookup.
+      * @param target The target to lookup the metadata on.
+      * @param targetKey The member on the target to lookup the metadata on.
+      */
     get(metadataKey: string, target: Function, targetKey: string): Object;
+    
+    /**
+      * Gets metadata specified by a key on a target, only searching the own instance.
+      * @param metadataKey The key for the metadata to lookup.
+      * @param target The target to lookup the metadata on.
+      * @param targetKey The member on the target to lookup the metadata on.
+      */
     getOwn(metadataKey: string, target: Function, targetKey: string): Object;
+    
+    /**
+      * Defines metadata specified by a key on a target.
+      * @param metadataKey The key for the metadata to define.
+      * @param target The target to set the metadata on.
+      * @param targetKey The member on the target to set the metadata on.
+      */
     define(metadataKey: string, metadataValue: Object, target: Function, targetKey: string): void;
+    
+    /**
+      * Gets metadata specified by a key on a target, or creates an instance of the specified metadata if not found.
+      * @param metadataKey The key for the metadata to lookup or create.
+      * @param Type The type of metadata to create if existing metadata is not found.
+      * @param target The target to lookup or create the metadata on.
+      * @param targetKey The member on the target to lookup or create the metadata on.
+      */
     getOrCreateOwn(metadataKey: string, Type: Function, target: Function, targetKey: string): Object;
   }
   
   /**
   * An object capable of applying it's captured decorators to a target.
   */
   export interface DecoratorApplicator {
+    
+    /**
+      * Applies the decorators to the target.
+      * @param target The target.
+      * @param key If applying to a method, the member name.
+      * @param key If applying to a method, you may supply an initial descriptor to pass to the decorators.
+      */
     on(target: any, key?: string, descriptor?: Object): any;
   }
   
@@ -54,8 +90,17 @@ declare module 'aurelia-metadata' {
   * Options used during protocol creation.
   */
   export interface ProtocolOptions {
-    validate(target: any): string | boolean;
-    compose(target: any): void;
+    
+    /**
+      * A function that will be run to validate the decorated class when the protocol is applied. It is also used to validate adhoc instances.
+      * If the validation fails, a message should be returned which directs the developer in how to address the issue.
+      */
+    validate?: (target: any) => string | boolean;
+    
+    /**
+      * A function which has the opportunity to compose additional behavior into the decorated class when the protocol is applied.
+      */
+    compose?: (target: any) => void;
   }
   
   /**
diff --git a/dist/es6/aurelia-metadata.d.ts b/dist/es6/aurelia-metadata.d.ts
@@ -21,16 +21,52 @@ declare module 'aurelia-metadata' {
       * The metadata key representing property information.
       */
     properties: string;
+    
+    /**
+      * Gets metadata specified by a key on a target, searching up the inheritance hierarchy.
+      * @param metadataKey The key for the metadata to lookup.
+      * @param target The target to lookup the metadata on.
+      * @param targetKey The member on the target to lookup the metadata on.
+      */
     get(metadataKey: string, target: Function, targetKey: string): Object;
+    
+    /**
+      * Gets metadata specified by a key on a target, only searching the own instance.
+      * @param metadataKey The key for the metadata to lookup.
+      * @param target The target to lookup the metadata on.
+      * @param targetKey The member on the target to lookup the metadata on.
+      */
     getOwn(metadataKey: string, target: Function, targetKey: string): Object;
+    
+    /**
+      * Defines metadata specified by a key on a target.
+      * @param metadataKey The key for the metadata to define.
+      * @param target The target to set the metadata on.
+      * @param targetKey The member on the target to set the metadata on.
+      */
     define(metadataKey: string, metadataValue: Object, target: Function, targetKey: string): void;
+    
+    /**
+      * Gets metadata specified by a key on a target, or creates an instance of the specified metadata if not found.
+      * @param metadataKey The key for the metadata to lookup or create.
+      * @param Type The type of metadata to create if existing metadata is not found.
+      * @param target The target to lookup or create the metadata on.
+      * @param targetKey The member on the target to lookup or create the metadata on.
+      */
     getOrCreateOwn(metadataKey: string, Type: Function, target: Function, targetKey: string): Object;
   }
   
   /**
   * An object capable of applying it's captured decorators to a target.
   */
   export interface DecoratorApplicator {
+    
+    /**
+      * Applies the decorators to the target.
+      * @param target The target.
+      * @param key If applying to a method, the member name.
+      * @param key If applying to a method, you may supply an initial descriptor to pass to the decorators.
+      */
     on(target: any, key?: string, descriptor?: Object): any;
   }
   
@@ -54,8 +90,17 @@ declare module 'aurelia-metadata' {
   * Options used during protocol creation.
   */
   export interface ProtocolOptions {
-    validate(target: any): string | boolean;
-    compose(target: any): void;
+    
+    /**
+      * A function that will be run to validate the decorated class when the protocol is applied. It is also used to validate adhoc instances.
+      * If the validation fails, a message should be returned which directs the developer in how to address the issue.
+      */
+    validate?: (target: any) => string | boolean;
+    
+    /**
+      * A function which has the opportunity to compose additional behavior into the decorated class when the protocol is applied.
+      */
+    compose?: (target: any) => void;
   }
   
   /**
diff --git a/dist/system/aurelia-metadata.d.ts b/dist/system/aurelia-metadata.d.ts
diff --git a/doc/CHANGELOG.md b/doc/CHANGELOG.md
diff --git a/doc/api.json b/doc/api.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "aurelia-metadata",`
`3`		`- "version": "0.10.1",`
	`3`	`+ "version": "1.0.0-beta.1",`
`4`	`4`	`"description": "Utilities for reading and writing the metadata of JavaScript functions.",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"aurelia",`
`@@ -17,7 +17,7 @@`
`17`	`17`	`"url": "https://github.com/aurelia/metadata"`
`18`	`18`	`},`
`19`	`19`	`"dependencies": {`
`20`		`- "aurelia-pal": "^0.3.0",`
	`20`	`+ "aurelia-pal": "^1.0.0-beta.1",`
`21`	`21`	`"core-js": "zloirock/core-js"`
`22`	`22`	`}`
`23`	`23`	`}`
-Original file line number
+Diff line change
   },
   map: {
 -    "aurelia-pal": "github:aurelia/pal@0.3.0",
 +    "aurelia-pal": "npm:aurelia-pal@1.0.0-beta.1",
     "babel": "npm:[email protected]",
     "babel-runtime": "npm:[email protected]",
     "core-js": "npm:[email protected]",