repository-provider 25.5.12 → 26.0.2

package/README.md

@@ -66,6 +66,7 @@ console.log(await readme.getString());
     *   [equals](#equals)
         *   [Parameters](#parameters-8)
     *   [attributes](#attributes)
+    *   [writableAttributes](#writableattributes)
     *   [attributeMapping](#attributemapping)
 *   [description](#description)
 *   [id](#id)
@@ -178,6 +179,7 @@ console.log(await readme.getString());
     *   [equals](#equals-3)
         *   [Parameters](#parameters-45)
     *   [displayName](#displayname)
+    *   [update](#update)
     *   [toJSON](#tojson-2)
 *   [Project](#project)
     *   [Parameters](#parameters-46)
@@ -275,7 +277,6 @@ console.log(await readme.getString());
     *   [isLocked](#islocked-1)
     *   [isDisabled](#isdisabled-1)
     *   [isTemplate](#istemplate)
-    *   [update](#update)
     *   [branch](#branch-1)
         *   [Parameters](#parameters-65)
     *   [defaultBranch](#defaultbranch)
@@ -361,6 +362,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 *   `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 *   `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
 *   `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
+*   `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
 ## definePropertiesFromOptions
 
@@ -423,7 +425,8 @@ In other words only produce key value pairs if value is defined.
 
 *   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 *   `initial` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)
-*   `skip` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** keys not to put in the result (optional, default `[]`)
+*   `attributes`   (optional, default `object.constructor.attributes`)
+*   `attibutes` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to operator on
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** initial + defined values
 
@@ -460,7 +463,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 ### Parameters
 
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-*   `additionalProperties`  
+*   `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
 ### equals
 
@@ -474,7 +477,11 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 ### attributes
 
-options
+Attributes definitions
+
+### writableAttributes
+
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** writable attributes
 
 ### attributeMapping
 
@@ -1050,7 +1057,7 @@ Object with a name.
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-*   `additionalProperties`  
+*   `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
 ### Properties
 
@@ -1072,6 +1079,10 @@ Beatified name use for human displaying only.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** human readable name
 
+### update
+
+Preserve object attributes in the backing store.
+
 ### toJSON
 
 Provide name and all defined attributes.
@@ -1639,10 +1650,6 @@ By default we are not a template.
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
 
-### update
-
-Updates repositroy attributes.
-
 ### branch
 
 Lookup branch by name.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "25.5.12",
+  "version": "26.0.2",
   "publishConfig": {
     "access": "public"
   },
@@ -35,7 +35,7 @@
     "ava": "^3.15.0",
     "c8": "^7.10.0",
     "documentation": "^13.2.5",
-    "repository-provider-test-support": "^1.8.5",
+    "repository-provider-test-support": "^1.8.11",
     "semantic-release": "^18.0.1"
   },
   "engines": {

package/src/attribute.mjs

@@ -5,6 +5,7 @@
  * @property {string} type
  * @property {boolean} writable
  * @property {boolean} private
+ * @property {string} description
  */
 
 /**
@@ -145,12 +146,11 @@ export function getAttribute(object, name) {
  * In other words only produce key value pairs if value is defined.
  * @param {Object} object
  * @param {Object} initial
- * @param {string[]} skip keys not to put in the result
+ * @param {Object} attibutes to operator on
  * @return {Object} initial + defined values
  */
-export function optionJSON(object, initial = {}, skip = []) {
-  return Object.keys(object.constructor.attributes || {})
-    .filter(key => skip.indexOf(key) < 0)
+export function optionJSON(object, initial = {}, attributes=object.constructor.attributes) {
+  return Object.keys(attributes || {})
     .reduce((a, c) => {
       const value = object[c];
       if (value !== undefined && !(value instanceof Function)) {

package/src/base-object.mjs

@@ -2,10 +2,11 @@ import { definePropertiesFromOptions, mapAttributes } from "./attribute.mjs";
 
 /**
  * @param {Object} options
+ * @param {Object} additionalProperties
  */
 export class BaseObject {
   /**
-   * options
+   * Attributes definitions
    */
   static get attributes() {
     return {
@@ -37,10 +38,19 @@ export class BaseObject {
        */
       avatarURL: { type: "url" },
 
-      homePageURL: { type: "url" }
+      homePageURL: { type: "url", writable: true }
     };
   }
 
+  /**
+   * @return {Object} writable attributes
+   */
+  static get writableAttributes() {
+    return Object.fromEntries(
+      Object.entries(this.attributes).filter(([k, v]) => v.writable)
+    );
+  }
+
   /**
    * Map attributes between external and internal representation.
    * @return {Object}

package/src/hook.mjs

@@ -16,12 +16,12 @@ export class Hook extends BaseObject {
   static get attributes() {
     return {
       ...super.attributes,
-      name: { type: "string" },
-      url: { type: "url", description: "target url" },
-      secret: { type: "string", private: true },
-      content_type: { type: "string", default: "json" },
+      name: { type: "string", writable: true },
+      url: { type: "url", description: "target url", writable: true },
+      secret: { type: "string", private: true, writable: true },
+      content_type: { type: "string", default: "json", writable: true },
       insecure_ssl: { type: "boolean", default: false },
-      active: { type: "boolean", default: true }
+      active: { type: "boolean", default: true, writable: true }
     };
   }
 

package/src/named-object.mjs

@@ -5,6 +5,7 @@ import { BaseObject } from "./base-object.mjs";
  * Object with a name.
  * @param {string} name
  * @param {Object} options
+ * @param {Object} additionalProperties
  *
  * @property {string} name
  */
@@ -33,6 +34,13 @@ export class NamedObject extends BaseObject {
     return this.name;
   }
 
+  /**
+   * Preserve object attributes in the backing store.
+   */
+  async update()
+  {
+  }
+
   toString() {
     return this.name;
   }

package/src/pull-request.mjs

@@ -77,13 +77,13 @@ export class PullRequest extends NamedObject {
        * The one line description of the pull request.
        * @return {string}
        */
-      title: { type: "string" },
+      title: { type: "string", writable: true },
 
       /**
        * The description of the pull request.
        * @return {string}
        */
-      body: { type: "string" },
+      body: { type: "string", writable: true },
 
       /**
        * state of the pull request.

package/src/repository.mjs

@@ -37,7 +37,7 @@ export class Repository extends NamedObject {
        * URLs of the repository
        * @return {string[]}
        */
-      urls: {},
+      urls: { },
 
       cloneURL: { type: "url" },
 
@@ -54,7 +54,7 @@ export class Repository extends NamedObject {
       issuesURL: { type: "url" },
       size: { type: "integer" },
       language: { type: "string" },
-      isArchived: { type: "boolean", default: false },
+      isArchived: { type: "boolean", default: false, writable: true },
       isLocked: { type: "boolean", default: false },
       isDisabled: { type: "boolean", default: false },
       isTemplate: { type: "boolean", default: false },
@@ -230,13 +230,6 @@ export class Repository extends NamedObject {
     return false;
   }
 
-  /**
-   * Updates repositroy attributes.
-   */
-  async update()
-  {
-  }
-
   /**
    * Lookup branch by name.
    * @param {string} name