From 554a00467f4c3cd0a578dc3fa256b8bed7a05a25 Mon Sep 17 00:00:00 2001 From: Andy Boughton Date: Sun, 12 Feb 2017 11:33:52 -0500 Subject: [PATCH] Update publicly displayed docs to reflect the recent 0.2.0 release Stealth commit: this will be added to master after the 0.2 tag, but before the next release. --- docs/api.js | 22 +- docs/classes/CasAuthenticatedRouteMixin.html | 15 +- docs/classes/Citation.html | 223 +++++++++++ docs/classes/Collection.html | 15 +- docs/classes/Comment.html | 15 +- docs/classes/CommentReport.html | 15 +- docs/classes/CommentableMixin.html | 15 +- docs/classes/Contributor.html | 15 +- docs/classes/DraftRegistration.html | 15 +- docs/classes/FetchAllRouteMixin.html | 15 +- docs/classes/File.html | 15 +- docs/classes/FileCacheBypassMixin.html | 15 +- docs/classes/FileItemMixin.html | 15 +- docs/classes/FileProvider.html | 15 +- docs/classes/FileVersion.html | 15 +- docs/classes/GenericDataADapter.html | 15 +- docs/classes/InfinityCustomMixin.html | 15 +- docs/classes/Institution.html | 15 +- docs/classes/Log.html | 15 +- docs/classes/Metaschema.html | 15 +- docs/classes/Node.html | 23 +- docs/classes/NodeActionsMixin.html | 32 +- docs/classes/NodeLink.html | 15 +- docs/classes/OsfAdapter.html | 69 +++- docs/classes/OsfAgnosticAuthController.html | 15 +- docs/classes/OsfAgnosticAuthRoute.html | 15 +- docs/classes/OsfCookieAuthenticator.html | 17 +- docs/classes/OsfCookieAuthorizer.html | 15 +- docs/classes/OsfCookieLoginController.html | 15 +- docs/classes/OsfCookieLoginRoute.html | 15 +- docs/classes/OsfModel.html | 15 +- docs/classes/OsfSerializer.html | 15 +- docs/classes/OsfTokenAuthenticator.html | 15 +- docs/classes/OsfTokenAuthorizer.html | 15 +- .../classes/OsfTokenLoginControllerMixin.html | 15 +- docs/classes/OsfTokenLoginRouteMixin.html | 15 +- docs/classes/PaginatedControllerMixin.html | 15 +- docs/classes/PaginatedRouteMixin.html | 15 +- docs/classes/Preprint.html | 15 +- docs/classes/Registration.html | 15 +- docs/classes/RegistrationActionsMixin.html | 15 +- docs/classes/TaggableMixin.html | 15 +- docs/classes/Taxonomy.html | 15 +- docs/classes/User.html | 15 +- docs/classes/ajax-helpers.html | 15 +- docs/classes/auth.html | 15 +- docs/classes/citation-widget.html | 223 +++++++++++ docs/classes/comment-detail.html | 15 +- docs/classes/comment-form.html | 15 +- docs/classes/comment-pane.html | 15 +- docs/classes/current-user.html | 15 +- docs/classes/dropzone-widget.html | 15 +- docs/classes/elem-id.html | 57 +-- docs/classes/eosf-project-nav.html | 15 +- docs/classes/file-browser-icon.html | 15 +- docs/classes/file-browser.html | 15 +- docs/classes/file-chooser component.html | 15 +- docs/classes/file-manager.html | 15 +- docs/classes/file-renderer.html | 15 +- docs/classes/file-version.html | 15 +- docs/classes/file-widget.html | 15 +- docs/classes/fix-special-char-helper.html | 310 +++++++++++++++ docs/classes/fix-special-char.html | 303 +++++++++++++++ docs/classes/fixstring.html | 319 +++++++++++++++ docs/classes/navbar-auth-dropdown.html | 268 +++++++++++++ docs/classes/oauth-popup.html | 15 +- docs/classes/osf-copyright.html | 15 +- docs/classes/osf-footer.html | 15 +- docs/classes/osf-mode-footer.html | 15 +- docs/classes/osf-navbar.html | 46 +-- docs/classes/osf-paginator.html | 15 +- docs/classes/pagination-control.html | 15 +- docs/classes/permissions.html | 263 +++++++++++++ docs/classes/search-dropdown.html | 15 +- docs/classes/sign-up.html | 15 +- docs/classes/tags-widget.html | 15 +- docs/data.json | 366 +++++++++++++++--- docs/files/addon_adapters_osf-adapter.js.html | 36 +- .../addon_authenticators_osf-cookie.js.html | 18 +- .../addon_authenticators_osf-token.js.html | 15 +- .../addon_authorizers_osf-cookie.js.html | 15 +- .../files/addon_authorizers_osf-token.js.html | 15 +- ...mponents_citation-widget_component.js.html | 244 ++++++++++++ ...omponents_comment-detail_component.js.html | 15 +- ..._components_comment-form_component.js.html | 15 +- ..._components_comment-pane_component.js.html | 15 +- ...mponents_dropzone-widget_component.js.html | 15 +- ...ponents_eosf-project-nav_component.js.html | 15 +- ...onents_file-browser-icon_component.js.html | 15 +- ...onents_file-browser-item_component.js.html | 15 +- ..._components_file-browser_component.js.html | 15 +- ..._components_file-chooser_component.js.html | 15 +- ...components_file-renderer_component.js.html | 15 +- ..._components_file-version_component.js.html | 15 +- ...n_components_file-widget_component.js.html | 15 +- ...nts_navbar-auth-dropdown_component.js.html | 262 +++++++++++++ ...n_components_oauth-popup_component.js.html | 15 +- ...components_osf-copyright_component.js.html | 18 +- ...on_components_osf-footer_component.js.html | 15 +- ...mponents_osf-mode-footer_component.js.html | 15 +- ...on_components_osf-navbar_component.js.html | 52 +-- ...components_osf-paginator_component.js.html | 15 +- ...nents_pagination-control_component.js.html | 15 +- ...mponents_search-dropdown_component.js.html | 15 +- ...addon_components_sign-up_component.js.html | 15 +- ...n_components_tags-widget_component.js.html | 15 +- docs/files/addon_const_permissions.js.html | 28 +- docs/files/addon_helpers_elem-id.js.html | 15 +- .../addon_helpers_fix-special-char.js.html | 209 ++++++++++ ...don_mixins_cas-authenticated-route.js.html | 15 +- docs/files/addon_mixins_commentable.js.html | 15 +- .../addon_mixins_fetch-all-route.js.html | 15 +- .../addon_mixins_file-cache-bypass.js.html | 15 +- docs/files/addon_mixins_file-item.js.html | 15 +- .../addon_mixins_generic-data-adapter.js.html | 15 +- .../addon_mixins_infinity-custom.js.html | 15 +- docs/files/addon_mixins_node-actions.js.html | 43 +- ...ixins_osf-agnostic-auth-controller.js.html | 15 +- ...don_mixins_osf-agnostic-auth-route.js.html | 15 +- ...mixins_osf-cookie-login-controller.js.html | 15 +- ...ddon_mixins_osf-cookie-login-route.js.html | 15 +- ..._mixins_osf-token-login-controller.js.html | 15 +- ...addon_mixins_osf-token-login-route.js.html | 15 +- .../addon_mixins_paginated-controller.js.html | 15 +- .../addon_mixins_paginated-route.js.html | 15 +- .../addon_mixins_registration-actions.js.html | 15 +- .../files/addon_mixins_taggable-mixin.js.html | 15 +- docs/files/addon_models_citation.js.html | 207 ++++++++++ docs/files/addon_models_collection.js.html | 24 +- .../files/addon_models_comment-report.js.html | 17 +- docs/files/addon_models_comment.js.html | 23 +- docs/files/addon_models_contributor.js.html | 23 +- .../addon_models_draft-registration.js.html | 17 +- docs/files/addon_models_file-provider.js.html | 21 +- docs/files/addon_models_file-version.js.html | 17 +- docs/files/addon_models_file.js.html | 25 +- docs/files/addon_models_institution.js.html | 19 +- docs/files/addon_models_log.js.html | 17 +- docs/files/addon_models_metaschema.js.html | 17 +- docs/files/addon_models_node-link.js.html | 15 +- docs/files/addon_models_node.js.html | 54 ++- docs/files/addon_models_osf-model.js.html | 15 +- docs/files/addon_models_preprint.js.html | 24 +- docs/files/addon_models_registration.js.html | 23 +- docs/files/addon_models_taxonomy.js.html | 17 +- docs/files/addon_models_user.js.html | 23 +- .../addon_serializers_osf-serializer.js.html | 24 +- .../files/addon_services_current-user.js.html | 15 +- .../files/addon_services_file-manager.js.html | 15 +- docs/files/addon_transforms_fixstring.js.html | 220 +++++++++++ docs/files/addon_utils_ajax-helpers.js.html | 15 +- docs/files/addon_utils_auth.js.html | 17 +- .../addon_utils_fix-special-char.js.html | 213 ++++++++++ docs/index.html | 15 +- docs/modules/adapters.html | 15 +- docs/modules/authenticators.html | 15 +- docs/modules/authorizers.html | 15 +- docs/modules/components.html | 36 +- docs/modules/const.html | 216 +++++++++++ docs/modules/ember-osf.html | 95 ++++- docs/modules/ember-preprints.html | 15 +- docs/modules/ember.html | 15 +- docs/modules/helpers.html | 15 +- docs/modules/mixins.html | 15 +- docs/modules/models.html | 26 +- docs/modules/serializers.html | 15 +- docs/modules/services.html | 15 +- docs/modules/transforms.html | 225 +++++++++++ docs/modules/utils.html | 22 +- 169 files changed, 6137 insertions(+), 746 deletions(-) create mode 100644 docs/classes/Citation.html create mode 100644 docs/classes/citation-widget.html create mode 100644 docs/classes/fix-special-char-helper.html create mode 100644 docs/classes/fix-special-char.html create mode 100644 docs/classes/fixstring.html create mode 100644 docs/classes/navbar-auth-dropdown.html create mode 100644 docs/classes/permissions.html create mode 100644 docs/files/addon_components_citation-widget_component.js.html create mode 100644 docs/files/addon_components_navbar-auth-dropdown_component.js.html create mode 100644 docs/files/addon_helpers_fix-special-char.js.html create mode 100644 docs/files/addon_models_citation.js.html create mode 100644 docs/files/addon_transforms_fixstring.js.html create mode 100644 docs/files/addon_utils_fix-special-char.js.html create mode 100644 docs/modules/const.html create mode 100644 docs/modules/transforms.html diff --git a/docs/api.js b/docs/api.js index d93336640..f00c1a199 100644 --- a/docs/api.js +++ b/docs/api.js @@ -2,6 +2,7 @@ YUI.add("yuidoc-meta", function(Y) { Y.YUIDoc = { meta: { "classes": [ "CasAuthenticatedRouteMixin", + "Citation", "Collection", "Comment", "CommentReport", @@ -45,6 +46,7 @@ YUI.add("yuidoc-meta", function(Y) { "User", "ajax-helpers", "auth", + "citation-widget", "comment-detail", "comment-form", "comment-pane", @@ -59,6 +61,10 @@ YUI.add("yuidoc-meta", function(Y) { "file-renderer", "file-version", "file-widget", + "fix-special-char", + "fix-special-char-helper", + "fixstring", + "navbar-auth-dropdown", "oauth-popup", "osf-copyright", "osf-footer", @@ -66,6 +72,7 @@ YUI.add("yuidoc-meta", function(Y) { "osf-navbar", "osf-paginator", "pagination-control", + "permissions", "search-dropdown", "sign-up", "tags-widget" @@ -75,6 +82,7 @@ YUI.add("yuidoc-meta", function(Y) { "authenticators", "authorizers", "components", + "const", "ember", "ember-osf", "ember-preprints", @@ -83,6 +91,7 @@ YUI.add("yuidoc-meta", function(Y) { "models", "serializers", "services", + "transforms", "utils" ], "allModules": [ @@ -104,7 +113,11 @@ YUI.add("yuidoc-meta", function(Y) { { "displayName": "components", "name": "components", - "description": "Display information about an individual comment, including controls to edit, delete, and report.\nThis component is typically used as part of the `comment-pane` component; see that component for further information.\n\nSample usage:\n```handlebars\n{{comment-detail\n comment=comment\n editComment=attrs.editComment\n deleteComment=attrs.deleteComment\n restoreComment=attrs.restoreComment\n reportComment=attrs.reportComment}}\n```" + "description": "Lists citations for node in APA, MLA, and Chicago formats" + }, + { + "displayName": "const", + "name": "const" }, { "displayName": "ember", @@ -132,7 +145,7 @@ YUI.add("yuidoc-meta", function(Y) { { "displayName": "models", "name": "models", - "description": "Model for OSF APIv2 collections\nFor field and usage information, see:\n* https://api.osf.io/v2/docs/#!/v2/Collection_List_GET" + "description": "Model for OSF APIv2 citation styles" }, { "displayName": "serializers", @@ -144,6 +157,11 @@ YUI.add("yuidoc-meta", function(Y) { "name": "services", "description": "Access information about the currently logged in user" }, + { + "displayName": "transforms", + "name": "transforms", + "description": "Custom string field transform that uses the `fix-special-char` utility function to clean up malformed text sent\nfrom the server. This allows string fields to be correctly and transparently used in templates without manually fixing\nthese characters for display on each use.\n\n This transform is used when `fixstring` is passed as the type parameter to the DS.attr function.\n ```app/models/score.js\n import DS from 'ember-data';\n export default DS.Model.extend({\n astring: DS.attr('fixstring'),\n });\n ```" + }, { "displayName": "utils", "name": "utils", diff --git a/docs/classes/CasAuthenticatedRouteMixin.html b/docs/classes/CasAuthenticatedRouteMixin.html index 8484536bb..aff3c230b 100644 --- a/docs/classes/CasAuthenticatedRouteMixin.html +++ b/docs/classes/CasAuthenticatedRouteMixin.html @@ -2,7 +2,7 @@ - CasAuthenticatedRouteMixin - Ember OSF + CasAuthenticatedRouteMixin - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/Citation.html b/docs/classes/Citation.html new file mode 100644 index 000000000..1084be6a3 --- /dev/null +++ b/docs/classes/Citation.html @@ -0,0 +1,223 @@ + + + + + Citation - Ember OSF Addon + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2.0 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

Citation Class

+
+ + +
+ Defined in: addon/models/citation.js:10 +
+ + Module: models
+ Parent Module: ember-osf + +
+ + +
+

Model for OSF APIv2 citation styles

+ +
+ + +
+ + +
+
+

Item Index

+ + + + +
+ + + + +
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/classes/Collection.html b/docs/classes/Collection.html index 242257009..028a44853 100644 --- a/docs/classes/Collection.html +++ b/docs/classes/Collection.html @@ -2,7 +2,7 @@ - Collection - Ember OSF + Collection - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/Comment.html b/docs/classes/Comment.html index a4e47235b..0d68976cd 100644 --- a/docs/classes/Comment.html +++ b/docs/classes/Comment.html @@ -2,7 +2,7 @@ - Comment - Ember OSF + Comment - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/CommentReport.html b/docs/classes/CommentReport.html index de1048f29..1952ccdc7 100644 --- a/docs/classes/CommentReport.html +++ b/docs/classes/CommentReport.html @@ -2,7 +2,7 @@ - CommentReport - Ember OSF + CommentReport - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/CommentableMixin.html b/docs/classes/CommentableMixin.html index 5226bb001..a5ace9787 100644 --- a/docs/classes/CommentableMixin.html +++ b/docs/classes/CommentableMixin.html @@ -2,7 +2,7 @@ - CommentableMixin - Ember OSF + CommentableMixin - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/Contributor.html b/docs/classes/Contributor.html index a4408c1ef..2f06eac0f 100644 --- a/docs/classes/Contributor.html +++ b/docs/classes/Contributor.html @@ -2,7 +2,7 @@ - Contributor - Ember OSF + Contributor - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/DraftRegistration.html b/docs/classes/DraftRegistration.html index 1667b0a86..ae067df57 100644 --- a/docs/classes/DraftRegistration.html +++ b/docs/classes/DraftRegistration.html @@ -2,7 +2,7 @@ - DraftRegistration - Ember OSF + DraftRegistration - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/FetchAllRouteMixin.html b/docs/classes/FetchAllRouteMixin.html index b00ba073b..f8102a88e 100644 --- a/docs/classes/FetchAllRouteMixin.html +++ b/docs/classes/FetchAllRouteMixin.html @@ -2,7 +2,7 @@ - FetchAllRouteMixin - Ember OSF + FetchAllRouteMixin - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/File.html b/docs/classes/File.html index 0ae60c16c..2800d22e0 100644 --- a/docs/classes/File.html +++ b/docs/classes/File.html @@ -2,7 +2,7 @@ - File - Ember OSF + File - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/FileCacheBypassMixin.html b/docs/classes/FileCacheBypassMixin.html index 726d33b45..a12d9a720 100644 --- a/docs/classes/FileCacheBypassMixin.html +++ b/docs/classes/FileCacheBypassMixin.html @@ -2,7 +2,7 @@ - FileCacheBypassMixin - Ember OSF + FileCacheBypassMixin - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/FileItemMixin.html b/docs/classes/FileItemMixin.html index c5aaf95d8..558d093dc 100644 --- a/docs/classes/FileItemMixin.html +++ b/docs/classes/FileItemMixin.html @@ -2,7 +2,7 @@ - FileItemMixin - Ember OSF + FileItemMixin - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/FileProvider.html b/docs/classes/FileProvider.html index 1515451be..597b043fb 100644 --- a/docs/classes/FileProvider.html +++ b/docs/classes/FileProvider.html @@ -2,7 +2,7 @@ - FileProvider - Ember OSF + FileProvider - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/FileVersion.html b/docs/classes/FileVersion.html index a99ca9845..52cc42061 100644 --- a/docs/classes/FileVersion.html +++ b/docs/classes/FileVersion.html @@ -2,7 +2,7 @@ - FileVersion - Ember OSF + FileVersion - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/GenericDataADapter.html b/docs/classes/GenericDataADapter.html index bd0fb6cdd..4a9d41f2f 100644 --- a/docs/classes/GenericDataADapter.html +++ b/docs/classes/GenericDataADapter.html @@ -2,7 +2,7 @@ - GenericDataADapter - Ember OSF + GenericDataADapter - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/InfinityCustomMixin.html b/docs/classes/InfinityCustomMixin.html index d735fe412..05c52567e 100644 --- a/docs/classes/InfinityCustomMixin.html +++ b/docs/classes/InfinityCustomMixin.html @@ -2,7 +2,7 @@ - InfinityCustomMixin - Ember OSF + InfinityCustomMixin - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/Institution.html b/docs/classes/Institution.html index b1754168f..78abe3f39 100644 --- a/docs/classes/Institution.html +++ b/docs/classes/Institution.html @@ -2,7 +2,7 @@ - Institution - Ember OSF + Institution - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/Log.html b/docs/classes/Log.html index 3a15b171a..fa8b070a7 100644 --- a/docs/classes/Log.html +++ b/docs/classes/Log.html @@ -2,7 +2,7 @@ - Log - Ember OSF + Log - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/Metaschema.html b/docs/classes/Metaschema.html index 4b53b6a9e..13b76ede0 100644 --- a/docs/classes/Metaschema.html +++ b/docs/classes/Metaschema.html @@ -2,7 +2,7 @@ - Metaschema - Ember OSF + Metaschema - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/Node.html b/docs/classes/Node.html index 1fd1b87c9..d31c734cd 100644 --- a/docs/classes/Node.html +++ b/docs/classes/Node.html @@ -2,7 +2,7 @@ - Node - Ember OSF + Node - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -258,7 +267,7 @@

isContributor

Defined in - addon/models/node.js:103 + addon/models/node.js:126

@@ -315,7 +324,7 @@

isAnonymous

Defined in - addon/models/node.js:96 + addon/models/node.js:119

@@ -340,7 +349,7 @@

isProject

Defined in - addon/models/node.js:83 + addon/models/node.js:106

@@ -365,7 +374,7 @@

isRegistration

Defined in - addon/models/node.js:89 + addon/models/node.js:112

diff --git a/docs/classes/NodeActionsMixin.html b/docs/classes/NodeActionsMixin.html index 80322d968..f138ed3bb 100644 --- a/docs/classes/NodeActionsMixin.html +++ b/docs/classes/NodeActionsMixin.html @@ -2,7 +2,7 @@ - NodeActionsMixin - Ember OSF + NodeActionsMixin - Ember OSF Addon @@ -14,10 +14,10 @@
-

Add a node link (pointer) to another node

+

Adds a relationship to another node, called a linkedNode.

@@ -680,7 +689,7 @@

Parameters:

-

ID of the node for which you wish to create a pointer

+

ID of the node for which you wish to create a link

@@ -693,7 +702,7 @@

Returns:

Promise: -

Returns a promise that resolves to model for the newly created NodeLink

+

Returns a promise that resolves to the newly updated node

@@ -883,7 +892,7 @@

removeNodeLink

(
  • - nodeLink + linkedNode
)
@@ -909,7 +918,7 @@

removeNodeLink

-

Remove a node link (pointer) to another node

+

Removes the linkedNode relationship to another node. Does not remove the linked node itself.

@@ -918,12 +927,12 @@

Parameters:

  • - nodeLink + linkedNode Object
    -

    nodeLink record to be destroyed.

    +

    linkedNode relationship to be destroyed.

    @@ -936,8 +945,7 @@

    Returns:

    Promise: -

    Returns a promise that resolves after the node link has been removed. This does not delete -the target node itself.

    +

    Returns a promise that resolves to the newly updated node

diff --git a/docs/classes/NodeLink.html b/docs/classes/NodeLink.html index c474bb64a..ebb4d6f40 100644 --- a/docs/classes/NodeLink.html +++ b/docs/classes/NodeLink.html @@ -2,7 +2,7 @@ - NodeLink - Ember OSF + NodeLink - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/OsfAdapter.html b/docs/classes/OsfAdapter.html index a5c71e76b..39782a702 100644 --- a/docs/classes/OsfAdapter.html +++ b/docs/classes/OsfAdapter.html @@ -2,7 +2,7 @@ - OsfAdapter - Ember OSF + OsfAdapter - Ember OSF Addon @@ -14,10 +14,10 @@ @@ -280,7 +293,7 @@

_addRelated

Defined in - addon/adapters/osf-adapter.js:93 + addon/adapters/osf-adapter.js:112

@@ -392,7 +405,7 @@

_buildRelationshipURL

Defined in - addon/adapters/osf-adapter.js:47 + addon/adapters/osf-adapter.js:66

@@ -481,7 +494,7 @@

_createRelated

Defined in - addon/adapters/osf-adapter.js:65 + addon/adapters/osf-adapter.js:84

@@ -601,7 +614,7 @@

_deleteRelated

Defined in - addon/adapters/osf-adapter.js:155 + addon/adapters/osf-adapter.js:174

@@ -724,7 +737,7 @@

_doRelatedRequest

Defined in - addon/adapters/osf-adapter.js:172 + addon/adapters/osf-adapter.js:191

@@ -851,7 +864,7 @@

_handleRelatedRequest

Defined in - addon/adapters/osf-adapter.js:229 + addon/adapters/osf-adapter.js:248

@@ -961,7 +974,7 @@

_removeRelated

Defined in - addon/adapters/osf-adapter.js:136 + addon/adapters/osf-adapter.js:155

@@ -1082,7 +1095,7 @@

_updateRelated

Defined in - addon/adapters/osf-adapter.js:114 + addon/adapters/osf-adapter.js:133

@@ -1164,6 +1177,40 @@

Parameters:

+
+
+

buildQuery

+ + () + + + + + + + + +
+

+ Defined in + addon/adapters/osf-adapter.js:32 +

+ + + +
+ +
+

Overrides buildQuery method - Allows users to embed resources with findRecord +OSF APIv2 does not have "include" functionality, instead we use 'embed'. +Usage: findRecord(type, id, {include: 'resource'}) or findRecord(type, id, {include: ['resource1', resource2]}) +Swaps included resources with embedded resources

+ +
+ + + +
diff --git a/docs/classes/OsfAgnosticAuthController.html b/docs/classes/OsfAgnosticAuthController.html index 156be6058..05ef0d736 100644 --- a/docs/classes/OsfAgnosticAuthController.html +++ b/docs/classes/OsfAgnosticAuthController.html @@ -2,7 +2,7 @@ - OsfAgnosticAuthController - Ember OSF + OsfAgnosticAuthController - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/OsfAgnosticAuthRoute.html b/docs/classes/OsfAgnosticAuthRoute.html index 1eedb83be..8c42a04f1 100644 --- a/docs/classes/OsfAgnosticAuthRoute.html +++ b/docs/classes/OsfAgnosticAuthRoute.html @@ -2,7 +2,7 @@ - OsfAgnosticAuthRoute - Ember OSF + OsfAgnosticAuthRoute - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/OsfCookieAuthenticator.html b/docs/classes/OsfCookieAuthenticator.html index 4b236e64d..8eb5f9373 100644 --- a/docs/classes/OsfCookieAuthenticator.html +++ b/docs/classes/OsfCookieAuthenticator.html @@ -2,7 +2,7 @@ - OsfCookieAuthenticator - Ember OSF + OsfCookieAuthenticator - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -237,7 +246,7 @@

authenticate

Defined in - addon/authenticators/osf-cookie.js:61 + addon/authenticators/osf-cookie.js:60

diff --git a/docs/classes/OsfCookieAuthorizer.html b/docs/classes/OsfCookieAuthorizer.html index e6738fa85..6e4dd5343 100644 --- a/docs/classes/OsfCookieAuthorizer.html +++ b/docs/classes/OsfCookieAuthorizer.html @@ -2,7 +2,7 @@ - OsfCookieAuthorizer - Ember OSF + OsfCookieAuthorizer - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/OsfCookieLoginController.html b/docs/classes/OsfCookieLoginController.html index 02d75eba4..0016c773d 100644 --- a/docs/classes/OsfCookieLoginController.html +++ b/docs/classes/OsfCookieLoginController.html @@ -2,7 +2,7 @@ - OsfCookieLoginController - Ember OSF + OsfCookieLoginController - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/OsfCookieLoginRoute.html b/docs/classes/OsfCookieLoginRoute.html index a9516c1f0..19999f5eb 100644 --- a/docs/classes/OsfCookieLoginRoute.html +++ b/docs/classes/OsfCookieLoginRoute.html @@ -2,7 +2,7 @@ - OsfCookieLoginRoute - Ember OSF + OsfCookieLoginRoute - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/OsfModel.html b/docs/classes/OsfModel.html index eb6c5282d..5d553f676 100644 --- a/docs/classes/OsfModel.html +++ b/docs/classes/OsfModel.html @@ -2,7 +2,7 @@ - OsfModel - Ember OSF + OsfModel - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/OsfSerializer.html b/docs/classes/OsfSerializer.html index 1ba0bb6b9..aee0692cc 100644 --- a/docs/classes/OsfSerializer.html +++ b/docs/classes/OsfSerializer.html @@ -2,7 +2,7 @@ - OsfSerializer - Ember OSF + OsfSerializer - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/OsfTokenAuthenticator.html b/docs/classes/OsfTokenAuthenticator.html index 9e5794419..c17196990 100644 --- a/docs/classes/OsfTokenAuthenticator.html +++ b/docs/classes/OsfTokenAuthenticator.html @@ -2,7 +2,7 @@ - OsfTokenAuthenticator - Ember OSF + OsfTokenAuthenticator - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/OsfTokenAuthorizer.html b/docs/classes/OsfTokenAuthorizer.html index da960f423..96f2a2414 100644 --- a/docs/classes/OsfTokenAuthorizer.html +++ b/docs/classes/OsfTokenAuthorizer.html @@ -2,7 +2,7 @@ - OsfTokenAuthorizer - Ember OSF + OsfTokenAuthorizer - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/OsfTokenLoginControllerMixin.html b/docs/classes/OsfTokenLoginControllerMixin.html index 56b34777b..78b4585cc 100644 --- a/docs/classes/OsfTokenLoginControllerMixin.html +++ b/docs/classes/OsfTokenLoginControllerMixin.html @@ -2,7 +2,7 @@ - OsfTokenLoginControllerMixin - Ember OSF + OsfTokenLoginControllerMixin - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/OsfTokenLoginRouteMixin.html b/docs/classes/OsfTokenLoginRouteMixin.html index bcf6a4504..17fcc86a6 100644 --- a/docs/classes/OsfTokenLoginRouteMixin.html +++ b/docs/classes/OsfTokenLoginRouteMixin.html @@ -2,7 +2,7 @@ - OsfTokenLoginRouteMixin - Ember OSF + OsfTokenLoginRouteMixin - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/PaginatedControllerMixin.html b/docs/classes/PaginatedControllerMixin.html index 76330e7ee..689b2d011 100644 --- a/docs/classes/PaginatedControllerMixin.html +++ b/docs/classes/PaginatedControllerMixin.html @@ -2,7 +2,7 @@ - PaginatedControllerMixin - Ember OSF + PaginatedControllerMixin - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/PaginatedRouteMixin.html b/docs/classes/PaginatedRouteMixin.html index 0dcb1468d..c987ba4e8 100644 --- a/docs/classes/PaginatedRouteMixin.html +++ b/docs/classes/PaginatedRouteMixin.html @@ -2,7 +2,7 @@ - PaginatedRouteMixin - Ember OSF + PaginatedRouteMixin - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/Preprint.html b/docs/classes/Preprint.html index 021699539..1645279af 100644 --- a/docs/classes/Preprint.html +++ b/docs/classes/Preprint.html @@ -2,7 +2,7 @@ - Preprint - Ember OSF + Preprint - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/Registration.html b/docs/classes/Registration.html index 3900f97e5..a00151832 100644 --- a/docs/classes/Registration.html +++ b/docs/classes/Registration.html @@ -2,7 +2,7 @@ - Registration - Ember OSF + Registration - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/RegistrationActionsMixin.html b/docs/classes/RegistrationActionsMixin.html index 725836c9c..c16f73e53 100644 --- a/docs/classes/RegistrationActionsMixin.html +++ b/docs/classes/RegistrationActionsMixin.html @@ -2,7 +2,7 @@ - RegistrationActionsMixin - Ember OSF + RegistrationActionsMixin - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/TaggableMixin.html b/docs/classes/TaggableMixin.html index 3b87407b5..121e16b46 100644 --- a/docs/classes/TaggableMixin.html +++ b/docs/classes/TaggableMixin.html @@ -2,7 +2,7 @@ - TaggableMixin - Ember OSF + TaggableMixin - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/Taxonomy.html b/docs/classes/Taxonomy.html index 9481a7f71..342810596 100644 --- a/docs/classes/Taxonomy.html +++ b/docs/classes/Taxonomy.html @@ -2,7 +2,7 @@ - Taxonomy - Ember OSF + Taxonomy - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/User.html b/docs/classes/User.html index 41fe97dc4..31ae8ea80 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -2,7 +2,7 @@ - User - Ember OSF + User - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/ajax-helpers.html b/docs/classes/ajax-helpers.html index a3e53ed3f..f7c261dc7 100644 --- a/docs/classes/ajax-helpers.html +++ b/docs/classes/ajax-helpers.html @@ -2,7 +2,7 @@ - ajax-helpers - Ember OSF + ajax-helpers - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/auth.html b/docs/classes/auth.html index 024e7f495..38a6b3d78 100644 --- a/docs/classes/auth.html +++ b/docs/classes/auth.html @@ -2,7 +2,7 @@ - auth - Ember OSF + auth - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/citation-widget.html b/docs/classes/citation-widget.html new file mode 100644 index 000000000..480cc5ac6 --- /dev/null +++ b/docs/classes/citation-widget.html @@ -0,0 +1,223 @@ + + + + + citation-widget - Ember OSF Addon + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2.0 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

citation-widget Class

+
+ + +
+ Defined in: addon/components/citation-widget/component.js:24 +
+ + Module: components
+ Parent Module: ember-osf + +
+ + +
+

Lists citations for node in APA, MLA, and Chicago formats

+ +
+ + +
+ + +
+
+

Item Index

+ + + + +
+ + + + +
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/classes/comment-detail.html b/docs/classes/comment-detail.html index 9b2e6bb30..fb4b25dda 100644 --- a/docs/classes/comment-detail.html +++ b/docs/classes/comment-detail.html @@ -2,7 +2,7 @@ - comment-detail - Ember OSF + comment-detail - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/comment-form.html b/docs/classes/comment-form.html index 633cb5306..8a066750c 100644 --- a/docs/classes/comment-form.html +++ b/docs/classes/comment-form.html @@ -2,7 +2,7 @@ - comment-form - Ember OSF + comment-form - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/comment-pane.html b/docs/classes/comment-pane.html index 6abfd8ae1..2c2b02b12 100644 --- a/docs/classes/comment-pane.html +++ b/docs/classes/comment-pane.html @@ -2,7 +2,7 @@ - comment-pane - Ember OSF + comment-pane - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/current-user.html b/docs/classes/current-user.html index 7a7197dcb..79bcc15c8 100644 --- a/docs/classes/current-user.html +++ b/docs/classes/current-user.html @@ -2,7 +2,7 @@ - current-user - Ember OSF + current-user - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/dropzone-widget.html b/docs/classes/dropzone-widget.html index 11adb5873..2e46120eb 100644 --- a/docs/classes/dropzone-widget.html +++ b/docs/classes/dropzone-widget.html @@ -2,7 +2,7 @@ - dropzone-widget - Ember OSF + dropzone-widget - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/elem-id.html b/docs/classes/elem-id.html index 9380103e7..62078cdb7 100644 --- a/docs/classes/elem-id.html +++ b/docs/classes/elem-id.html @@ -2,7 +2,7 @@ - elem-id - Ember OSF + elem-id - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -181,7 +190,6 @@

elem-id Class

@@ -189,52 +197,11 @@

elem-id Class

Item Index

-
-

Properties

- - -
-
-

Properties

- -
-

permissionSelector

- - - - - final - - -
-

Provided by the ember-osf module.

-

- Defined in - addon/const/permissions.js:5 -

- - -
- -
-

Provide human-readable labels for permissions fields. Useful in dropdown UI.

- -
- - - -
-
diff --git a/docs/classes/eosf-project-nav.html b/docs/classes/eosf-project-nav.html index 59cc82a00..1a15c4bdb 100644 --- a/docs/classes/eosf-project-nav.html +++ b/docs/classes/eosf-project-nav.html @@ -2,7 +2,7 @@ - eosf-project-nav - Ember OSF + eosf-project-nav - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/file-browser-icon.html b/docs/classes/file-browser-icon.html index 1f232583c..444376309 100644 --- a/docs/classes/file-browser-icon.html +++ b/docs/classes/file-browser-icon.html @@ -2,7 +2,7 @@ - file-browser-icon - Ember OSF + file-browser-icon - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/file-browser.html b/docs/classes/file-browser.html index 8fe055436..9aeacb1d7 100644 --- a/docs/classes/file-browser.html +++ b/docs/classes/file-browser.html @@ -2,7 +2,7 @@ - file-browser - Ember OSF + file-browser - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/file-chooser component.html b/docs/classes/file-chooser component.html index 323ae9e42..cff893315 100644 --- a/docs/classes/file-chooser component.html +++ b/docs/classes/file-chooser component.html @@ -2,7 +2,7 @@ - file-chooser component - Ember OSF + file-chooser component - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/file-manager.html b/docs/classes/file-manager.html index 77ccfc9b3..dbe29b7c6 100644 --- a/docs/classes/file-manager.html +++ b/docs/classes/file-manager.html @@ -2,7 +2,7 @@ - file-manager - Ember OSF + file-manager - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/file-renderer.html b/docs/classes/file-renderer.html index 8fa9fb338..aa8b06189 100644 --- a/docs/classes/file-renderer.html +++ b/docs/classes/file-renderer.html @@ -2,7 +2,7 @@ - file-renderer - Ember OSF + file-renderer - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/file-version.html b/docs/classes/file-version.html index 2747a935b..b553c3473 100644 --- a/docs/classes/file-version.html +++ b/docs/classes/file-version.html @@ -2,7 +2,7 @@ - file-version - Ember OSF + file-version - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/file-widget.html b/docs/classes/file-widget.html index 4167a3790..ab470d3c1 100644 --- a/docs/classes/file-widget.html +++ b/docs/classes/file-widget.html @@ -2,7 +2,7 @@ - file-widget - Ember OSF + file-widget - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/fix-special-char-helper.html b/docs/classes/fix-special-char-helper.html new file mode 100644 index 000000000..86317de7a --- /dev/null +++ b/docs/classes/fix-special-char-helper.html @@ -0,0 +1,310 @@ + + + + + fix-special-char-helper - Ember OSF Addon + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2.0 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

fix-special-char-helper Class

+
+
+ Uses + +
+ + +
+ Defined in: addon/helpers/fix-special-char.js:4 +
+ + Module: ember-osf + +
+ + +
+

Apply the fix-special-char utility function to clean up malformed text sent from the server.

+

Usage example:

+
   This is text we want to fix: {{fix-special-char 'Now & then'}}
+
+ +
+ + +
+ + +
+
+

Item Index

+ +
+

Methods

+ + +
+ + + +
+ +
+

Methods

+ +
+

fixSpecialChar

+ +
+ (
    +
  • + inputString +
    • +
) +
+ + + String | Null + + + + + + + + +
+

Inherited from + fix-special-char: + addon/utils/fix-special-char.js:10 +

+ + + +
+ +
+ This function is useful for fixing a bad API behavior. In certain cases the server will insert HTML escape +sequences into text, and this will replace & sequences with &. Template helper and ember-data field versions +of this function are available. +
+ +
+

Parameters:

+ +
    +
  • + inputString + String + + +
    + A string value to be transformed +
    + +
    • +
+
+ +
+

Returns:

+ +
+ String | Null: +
+
+ + +
+
+ + + +
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/classes/fix-special-char.html b/docs/classes/fix-special-char.html new file mode 100644 index 000000000..18268f282 --- /dev/null +++ b/docs/classes/fix-special-char.html @@ -0,0 +1,303 @@ + + + + + fix-special-char - Ember OSF Addon + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2.0 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

fix-special-char Class

+
+ + +
+ Defined in: addon/utils/fix-special-char.js:6 +
+ + Module: utils
+ Parent Module: ember-osf + +
+ + +
+ +
+ + +
+ + +
+
+

Item Index

+ +
+

Methods

+ + +
+ + + +
+ +
+

Methods

+ +
+

fixSpecialChar

+ +
+ (
    +
  • + inputString +
    • +
) +
+ + + String | Null + + + + + + + + +
+

+ Defined in + addon/utils/fix-special-char.js:10 +

+ + + +
+ +
+

This function is useful for fixing a bad API behavior. In certain cases the server will insert HTML escape +sequences into text, and this will replace & sequences with &. Template helper and ember-data field versions +of this function are available.

+ +
+ +
+

Parameters:

+ +
    +
  • + inputString + String + + +
    +

    A string value to be transformed

    + +
    + +
    • +
+
+ +
+

Returns:

+ +
+ String | Null: +
+
+ + +
+
+ + + +
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/classes/fixstring.html b/docs/classes/fixstring.html new file mode 100644 index 000000000..644979803 --- /dev/null +++ b/docs/classes/fixstring.html @@ -0,0 +1,319 @@ + + + + + fixstring - Ember OSF Addon + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2.0 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

fixstring Class

+
+
+ Uses + +
+ +
+ Extends DS.StringTransform +
+ +
+ Defined in: addon/transforms/fixstring.js:10 +
+ + Module: transforms
+ Parent Module: ember-osf + +
+ + +
+

Custom string field transform that uses the fix-special-char utility function to clean up malformed text sent +from the server. This allows string fields to be correctly and transparently used in templates without manually fixing +these characters for display on each use.

+

This transform is used when fixstring is passed as the type parameter to the DS.attr function.

+
 import DS from 'ember-data';
+ export default DS.Model.extend({
+    astring: DS.attr('fixstring'),
+ });
+
+ +
+ + +
+ + +
+
+

Item Index

+ +
+

Methods

+ + +
+ + + +
+ +
+

Methods

+ +
+

fixSpecialChar

+ +
+ (
    +
  • + inputString +
    • +
) +
+ + + String | Null + + + + + + + + +
+

Inherited from + fix-special-char: + addon/utils/fix-special-char.js:10 +

+ + + +
+ +
+ This function is useful for fixing a bad API behavior. In certain cases the server will insert HTML escape +sequences into text, and this will replace & sequences with &. Template helper and ember-data field versions +of this function are available. +
+ +
+

Parameters:

+ +
    +
  • + inputString + String + + +
    + A string value to be transformed +
    + +
    • +
+
+ +
+

Returns:

+ +
+ String | Null: +
+
+ + +
+
+ + + +
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/classes/navbar-auth-dropdown.html b/docs/classes/navbar-auth-dropdown.html new file mode 100644 index 000000000..5414fa4c3 --- /dev/null +++ b/docs/classes/navbar-auth-dropdown.html @@ -0,0 +1,268 @@ + + + + + navbar-auth-dropdown - Ember OSF Addon + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2.0 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

navbar-auth-dropdown Class

+
+ + +
+ Defined in: addon/components/navbar-auth-dropdown/component.js:10 +
+ + Module: components
+ Parent Module: ember-osf + +
+ + +
+

Display the login dropdown on the navbar

+

Sample usage:

+
{{navbar-auth-dropdown
+  loginAction=loginAction
+  redirectUrl=redirectUrl}}
+
+ +
+ + +
+ + +
+
+

Item Index

+ + +
+

Properties

+ + +
+ + +
+ + +
+

Properties

+ +
+

signupUrl

+ String + + + + + +
+

+ Defined in + addon/components/navbar-auth-dropdown/component.js:33 +

+ + +
+ +
+

The URL to use for signup. May be overridden, eg for special campaign pages

+ +
+ + + +
+
+ + +
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/classes/oauth-popup.html b/docs/classes/oauth-popup.html index b1ace4fbe..2c232375a 100644 --- a/docs/classes/oauth-popup.html +++ b/docs/classes/oauth-popup.html @@ -2,7 +2,7 @@ - oauth-popup - Ember OSF + oauth-popup - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/osf-copyright.html b/docs/classes/osf-copyright.html index 0dbe349ea..dc9df4bd8 100644 --- a/docs/classes/osf-copyright.html +++ b/docs/classes/osf-copyright.html @@ -2,7 +2,7 @@ - osf-copyright - Ember OSF + osf-copyright - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/osf-footer.html b/docs/classes/osf-footer.html index 758beb524..95a2d7893 100644 --- a/docs/classes/osf-footer.html +++ b/docs/classes/osf-footer.html @@ -2,7 +2,7 @@ - osf-footer - Ember OSF + osf-footer - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/osf-mode-footer.html b/docs/classes/osf-mode-footer.html index a7bb64ceb..9a39c6b68 100644 --- a/docs/classes/osf-mode-footer.html +++ b/docs/classes/osf-mode-footer.html @@ -2,7 +2,7 @@ - osf-mode-footer - Ember OSF + osf-mode-footer - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/osf-navbar.html b/docs/classes/osf-navbar.html index a951406fa..10c5c8c79 100644 --- a/docs/classes/osf-navbar.html +++ b/docs/classes/osf-navbar.html @@ -2,7 +2,7 @@ - osf-navbar - Ember OSF + osf-navbar - Ember OSF Addon @@ -14,10 +14,10 @@ @@ -226,7 +231,7 @@

hideSearch

Defined in - addon/components/osf-navbar/component.js:27 + addon/components/osf-navbar/component.js:26

@@ -239,31 +244,6 @@

hideSearch

-
-
-

signupUrl

- String - - - - - -
-

- Defined in - addon/components/osf-navbar/component.js:34 -

- - -
- -
-

The URL to use for signup. May be overridden, eg for special campaign pages

- -
- - -
diff --git a/docs/classes/osf-paginator.html b/docs/classes/osf-paginator.html index b68fbc44d..5ef194623 100644 --- a/docs/classes/osf-paginator.html +++ b/docs/classes/osf-paginator.html @@ -2,7 +2,7 @@ - osf-paginator - Ember OSF + osf-paginator - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/pagination-control.html b/docs/classes/pagination-control.html index 069b5d848..b1335b172 100644 --- a/docs/classes/pagination-control.html +++ b/docs/classes/pagination-control.html @@ -2,7 +2,7 @@ - pagination-control - Ember OSF + pagination-control - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/permissions.html b/docs/classes/permissions.html new file mode 100644 index 000000000..2be3be854 --- /dev/null +++ b/docs/classes/permissions.html @@ -0,0 +1,263 @@ + + + + + permissions - Ember OSF Addon + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2.0 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

permissions Class

+
+ + +
+ Defined in: addon/const/permissions.js:10 +
+ + Module: const
+ Parent Module: ember-osf + +
+ + +
+ +
+ + +
+ + +
+
+

Item Index

+ + +
+

Properties

+ + +
+ + +
+ + +
+

Properties

+ +
+

permissionSelector

+ Object[] + + + + final + + +
+

+ Defined in + addon/const/permissions.js:14 +

+ + +
+ +
+

Provide human-readable labels for permissions fields. Useful in dropdown UI.

+ +
+ + + +
+
+ + +
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/classes/search-dropdown.html b/docs/classes/search-dropdown.html index 567f59539..5ba0a8757 100644 --- a/docs/classes/search-dropdown.html +++ b/docs/classes/search-dropdown.html @@ -2,7 +2,7 @@ - search-dropdown - Ember OSF + search-dropdown - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/sign-up.html b/docs/classes/sign-up.html index 47a487a9a..0c31d7ca9 100644 --- a/docs/classes/sign-up.html +++ b/docs/classes/sign-up.html @@ -2,7 +2,7 @@ - sign-up - Ember OSF + sign-up - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/classes/tags-widget.html b/docs/classes/tags-widget.html index 0dc991440..71d038554 100644 --- a/docs/classes/tags-widget.html +++ b/docs/classes/tags-widget.html @@ -2,7 +2,7 @@ - tags-widget - Ember OSF + tags-widget - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/data.json b/docs/data.json index 51fe0ce68..ea986f407 100644 --- a/docs/data.json +++ b/docs/data.json @@ -1,10 +1,10 @@ { "project": { - "name": "Ember OSF", + "name": "Ember OSF Addon", "description": "Ember components for interacting with the Open Science Framework", - "version": "0.0.1", "url": "https://github.com/CenterForOpenScience/ember-osf", - "logo": "https://cos.io/static/img/icons/cos_wide.png" + "logo": "https://cos.io/static/img/icons/cos_wide.png", + "version": "0.2.0" }, "files": { "addon/adapters/osf-adapter.js": { @@ -58,11 +58,20 @@ "fors": {}, "namespaces": {} }, - "addon/components/comment-detail/component.js": { - "name": "addon/components/comment-detail/component.js", + "addon/components/citation-widget/component.js": { + "name": "addon/components/citation-widget/component.js", "modules": { "components": 1 }, + "classes": { + "citation-widget": 1 + }, + "fors": {}, + "namespaces": {} + }, + "addon/components/comment-detail/component.js": { + "name": "addon/components/comment-detail/component.js", + "modules": {}, "classes": { "comment-detail": 1 }, @@ -166,6 +175,15 @@ "fors": {}, "namespaces": {} }, + "addon/components/navbar-auth-dropdown/component.js": { + "name": "addon/components/navbar-auth-dropdown/component.js", + "modules": {}, + "classes": { + "navbar-auth-dropdown": 1 + }, + "fors": {}, + "namespaces": {} + }, "addon/components/oauth-popup/component.js": { "name": "addon/components/oauth-popup/component.js", "modules": {}, @@ -258,8 +276,12 @@ }, "addon/const/permissions.js": { "name": "addon/const/permissions.js", - "modules": {}, - "classes": {}, + "modules": { + "const": 1 + }, + "classes": { + "permissions": 1 + }, "fors": {}, "namespaces": {} }, @@ -274,6 +296,15 @@ "fors": {}, "namespaces": {} }, + "addon/helpers/fix-special-char.js": { + "name": "addon/helpers/fix-special-char.js", + "modules": {}, + "classes": { + "fix-special-char-helper": 1 + }, + "fors": {}, + "namespaces": {} + }, "addon/mixins/cas-authenticated-route.js": { "name": "addon/mixins/cas-authenticated-route.js", "modules": { @@ -438,11 +469,20 @@ "fors": {}, "namespaces": {} }, - "addon/models/collection.js": { - "name": "addon/models/collection.js", + "addon/models/citation.js": { + "name": "addon/models/citation.js", "modules": { "models": 1 }, + "classes": { + "Citation": 1 + }, + "fors": {}, + "namespaces": {} + }, + "addon/models/collection.js": { + "name": "addon/models/collection.js", + "modules": {}, "classes": { "Collection": 1 }, @@ -633,6 +673,17 @@ "fors": {}, "namespaces": {} }, + "addon/transforms/fixstring.js": { + "name": "addon/transforms/fixstring.js", + "modules": { + "transforms": 1 + }, + "classes": { + "fixstring": 1 + }, + "fors": {}, + "namespaces": {} + }, "addon/utils/ajax-helpers.js": { "name": "addon/utils/ajax-helpers.js", "modules": { @@ -653,6 +704,15 @@ }, "fors": {}, "namespaces": {} + }, + "addon/utils/fix-special-char.js": { + "name": "addon/utils/fix-special-char.js", + "modules": {}, + "classes": { + "fix-special-char": 1 + }, + "fors": {}, + "namespaces": {} } }, "modules": { @@ -663,11 +723,13 @@ "authenticators": 1, "authorizers": 1, "components": 1, + "const": 1, "helpers": 1, "mixins": 1, "models": 1, "serializers": 1, - "services": 1 + "services": 1, + "transforms": 1 }, "elements": {}, "classes": { @@ -676,6 +738,7 @@ "OsfTokenAuthenticator": 1, "OsfCookieAuthorizer": 1, "OsfTokenAuthorizer": 1, + "citation-widget": 1, "comment-detail": 1, "comment-form": 1, "comment-pane": 1, @@ -687,6 +750,7 @@ "file-renderer": 1, "file-version": 1, "file-widget": 1, + "navbar-auth-dropdown": 1, "oauth-popup": 1, "osf-copyright": 1, "osf-footer": 1, @@ -697,7 +761,9 @@ "search-dropdown": 1, "sign-up": 1, "tags-widget": 1, + "permissions": 1, "elem-id": 1, + "fix-special-char-helper": 1, "CasAuthenticatedRouteMixin": 1, "CommentableMixin": 1, "FetchAllRouteMixin": 1, @@ -715,6 +781,7 @@ "PaginatedRouteMixin": 1, "RegistrationActionsMixin": 1, "TaggableMixin": 1, + "Citation": 1, "Collection": 1, "CommentReport": 1, "Comment": 1, @@ -734,13 +801,15 @@ "OsfSerializer": 1, "current-user": 1, "file-manager": 1, - "auth": 1 + "fixstring": 1, + "auth": 1, + "fix-special-char": 1 }, "fors": {}, "namespaces": {}, "tag": "module", - "file": "addon/utils/auth.js", - "line": 10, + "file": "addon/utils/fix-special-char.js", + "line": 6, "description": "Helper functions for asynchronous behavior" }, "adapters": { @@ -798,6 +867,7 @@ "submodules": {}, "elements": {}, "classes": { + "citation-widget": 1, "comment-detail": 1, "comment-form": 1, "comment-pane": 1, @@ -809,6 +879,7 @@ "file-renderer": 1, "file-version": 1, "file-widget": 1, + "navbar-auth-dropdown": 1, "oauth-popup": 1, "osf-copyright": 1, "osf-footer": 1, @@ -827,7 +898,22 @@ "namespace": "", "file": "addon/components/tags-widget/component.js", "line": 9, - "description": "Display information about an individual comment, including controls to edit, delete, and report.\nThis component is typically used as part of the `comment-pane` component; see that component for further information.\n\nSample usage:\n```handlebars\n{{comment-detail\n comment=comment\n editComment=attrs.editComment\n deleteComment=attrs.deleteComment\n restoreComment=attrs.restoreComment\n reportComment=attrs.reportComment}}\n```" + "description": "Lists citations for node in APA, MLA, and Chicago formats" + }, + "const": { + "name": "const", + "submodules": {}, + "elements": {}, + "classes": { + "permissions": 1 + }, + "fors": {}, + "is_submodule": 1, + "namespaces": {}, + "module": "ember-osf", + "namespace": "", + "file": "addon/const/permissions.js", + "line": 10 }, "helpers": { "name": "helpers", @@ -894,6 +980,7 @@ "submodules": {}, "elements": {}, "classes": { + "Citation": 1, "Collection": 1, "CommentReport": 1, "Comment": 1, @@ -920,7 +1007,7 @@ "namespace": "", "file": "addon/models/user.js", "line": 11, - "description": "Model for OSF APIv2 collections\nFor field and usage information, see:\n* https://api.osf.io/v2/docs/#!/v2/Collection_List_GET" + "description": "Model for OSF APIv2 citation styles" }, "ember-preprints": { "name": "ember-preprints", @@ -968,19 +1055,36 @@ "line": 11, "description": "Access information about the currently logged in user" }, + "transforms": { + "name": "transforms", + "submodules": {}, + "elements": {}, + "classes": { + "fixstring": 1 + }, + "fors": {}, + "is_submodule": 1, + "namespaces": {}, + "module": "ember-osf", + "namespace": "", + "file": "addon/transforms/fixstring.js", + "line": 10, + "description": "Custom string field transform that uses the `fix-special-char` utility function to clean up malformed text sent\nfrom the server. This allows string fields to be correctly and transparently used in templates without manually fixing\nthese characters for display on each use.\n\n This transform is used when `fixstring` is passed as the type parameter to the DS.attr function.\n ```app/models/score.js\n import DS from 'ember-data';\n export default DS.Model.extend({\n astring: DS.attr('fixstring'),\n });\n ```" + }, "utils": { "name": "utils", "submodules": {}, "elements": {}, "classes": { "ajax-helpers": 1, - "auth": 1 + "auth": 1, + "fix-special-char": 1 }, "fors": {}, "namespaces": {}, "tag": "module", - "file": "addon/utils/auth.js", - "line": 10, + "file": "addon/utils/fix-special-char.js", + "line": 6, "description": "Helper functions for asynchronous behavior", "module": "ember-osf" } @@ -1070,6 +1174,28 @@ "description": "Ember-simple-auth compatible authorizer based on OAuth2 bearer tokens.\n\nIntended to be used with the authenticator of the same name.", "extends": "ember-simple-auth/BaseAuthorizer" }, + "citation-widget": { + "name": "citation-widget", + "shortname": "citation-widget", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "ember-osf", + "submodule": "components", + "namespace": "", + "file": "addon/components/citation-widget/component.js", + "line": 24, + "description": "Lists citations for node in APA, MLA, and Chicago formats", + "params": [ + { + "name": "node", + "description": "for which to fetch citations", + "type": "Node" + } + ] + }, "comment-detail": { "name": "comment-detail", "shortname": "comment-detail", @@ -1301,6 +1427,21 @@ "line": 13, "description": "Widget to quickly upload a file to a selected project\n```handlebars\n{{file-widget\n preUpload=(action 'preUpload')\n buildUrl=(action 'buildUrl')\n listeners=dropzoneOptions\n options=dropzoneOptions}}\n```" }, + "navbar-auth-dropdown": { + "name": "navbar-auth-dropdown", + "shortname": "navbar-auth-dropdown", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "ember-osf", + "submodule": "components", + "namespace": "", + "file": "addon/components/navbar-auth-dropdown/component.js", + "line": 10, + "description": "Display the login dropdown on the navbar\n\nSample usage:\n```handlebars\n{{navbar-auth-dropdown\n loginAction=loginAction\n redirectUrl=redirectUrl}}\n```" + }, "oauth-popup": { "name": "oauth-popup", "shortname": "oauth-popup", @@ -1469,6 +1610,20 @@ "description": "Allow the user to view and manage tags.\nSee TaggableMixin for controller actions that can be used with this component.\n\nFor more information on configuration options, see documentation for [jquery-tags-input](https://github.com/xoxco/jQuery-Tags-Input).\n\n```handlebars\n{{tags-widget\n addATag=(action 'addATag' model)\n removeATag=(action 'removeATag' model)\n tags=model.tags}}\n```", "extends": "Ember.Component" }, + "permissions": { + "name": "permissions", + "shortname": "permissions", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "ember-osf", + "submodule": "const", + "namespace": "", + "file": "addon/const/permissions.js", + "line": 10 + }, "elem-id": { "name": "elem-id", "shortname": "elem-id", @@ -1496,6 +1651,23 @@ } ] }, + "fix-special-char-helper": { + "name": "fix-special-char-helper", + "shortname": "fix-special-char-helper", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "ember-osf", + "namespace": "", + "file": "addon/helpers/fix-special-char.js", + "line": 4, + "description": "Apply the `fix-special-char` utility function to clean up malformed text sent from the server.\n\nUsage example:\n```handlebars\n This is text we want to fix: {{fix-special-char 'Now & then'}}\n ```", + "uses": [ + "fix-special-char" + ] + }, "CasAuthenticatedRouteMixin": { "name": "CasAuthenticatedRouteMixin", "shortname": "CasAuthenticatedRouteMixin", @@ -1800,6 +1972,21 @@ "description": "Controller mixin that implements basic tagging functionality. Uses the model defined in the model hook.", "extends": "Ember.Mixin" }, + "Citation": { + "name": "Citation", + "shortname": "Citation", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "ember-osf", + "submodule": "models", + "namespace": "", + "file": "addon/models/citation.js", + "line": 10, + "description": "Model for OSF APIv2 citation styles" + }, "Collection": { "name": "Collection", "shortname": "Collection", @@ -2120,6 +2307,25 @@ "description": "An Ember service for doing things to files.\nEssentially a wrapper for the Waterbutler API.\nhttp://waterbutler.readthedocs.io/", "extends": "Ember.Service" }, + "fixstring": { + "name": "fixstring", + "shortname": "fixstring", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "ember-osf", + "submodule": "transforms", + "namespace": "", + "file": "addon/transforms/fixstring.js", + "line": 10, + "description": "Custom string field transform that uses the `fix-special-char` utility function to clean up malformed text sent\nfrom the server. This allows string fields to be correctly and transparently used in templates without manually fixing\nthese characters for display on each use.\n\n This transform is used when `fixstring` is passed as the type parameter to the DS.attr function.\n ```app/models/score.js\n import DS from 'ember-data';\n export default DS.Model.extend({\n astring: DS.attr('fixstring'),\n });\n ```", + "extends": "DS.StringTransform", + "uses": [ + "fix-special-char" + ] + }, "ajax-helpers": { "name": "ajax-helpers", "shortname": "ajax-helpers", @@ -2147,13 +2353,40 @@ "namespace": "", "file": "addon/utils/auth.js", "line": 10 + }, + "fix-special-char": { + "name": "fix-special-char", + "shortname": "fix-special-char", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [ + "fix-special-char-helper", + "fixstring" + ], + "module": "ember-osf", + "submodule": "utils", + "namespace": "", + "file": "addon/utils/fix-special-char.js", + "line": 6 } }, "elements": {}, "classitems": [ { "file": "addon/adapters/osf-adapter.js", - "line": 47, + "line": 32, + "description": "Overrides buildQuery method - Allows users to embed resources with findRecord\nOSF APIv2 does not have \"include\" functionality, instead we use 'embed'.\nUsage: findRecord(type, id, {include: 'resource'}) or findRecord(type, id, {include: ['resource1', resource2]})\nSwaps included resources with embedded resources", + "itemtype": "method", + "name": "buildQuery", + "class": "OsfAdapter", + "module": "ember-osf", + "submodule": "adapters" + }, + { + "file": "addon/adapters/osf-adapter.js", + "line": 66, "description": "Construct a URL for a relationship create/update/delete.", "itemtype": "method", "name": "_buildRelationshipURL", @@ -2181,7 +2414,7 @@ }, { "file": "addon/adapters/osf-adapter.js", - "line": 65, + "line": 84, "description": "Handle creation of related resources", "itemtype": "method", "name": "_createRelated", @@ -2225,7 +2458,7 @@ }, { "file": "addon/adapters/osf-adapter.js", - "line": 93, + "line": 112, "description": "Handle add(s) of related resources. This differs from CREATEs in that the related\nrecord is already saved and is just being associated with the inverse record.", "itemtype": "method", "name": "_addRelated", @@ -2269,7 +2502,7 @@ }, { "file": "addon/adapters/osf-adapter.js", - "line": 114, + "line": 133, "description": "Handle update(s) of related resources", "itemtype": "method", "name": "_updateRelated", @@ -2313,7 +2546,7 @@ }, { "file": "addon/adapters/osf-adapter.js", - "line": 136, + "line": 155, "description": "Handle removal of related resources. This differs from DELETEs in that the related\nrecord is not deleted, just dissociated from the inverse record.", "itemtype": "method", "name": "_removeRelated", @@ -2357,7 +2590,7 @@ }, { "file": "addon/adapters/osf-adapter.js", - "line": 155, + "line": 174, "description": "Handle deletion of related resources", "itemtype": "method", "name": "_deleteRelated", @@ -2401,7 +2634,7 @@ }, { "file": "addon/adapters/osf-adapter.js", - "line": 172, + "line": 191, "description": "A helper for making _*Related requests", "itemtype": "method", "name": "_doRelatedRequest", @@ -2450,7 +2683,7 @@ }, { "file": "addon/adapters/osf-adapter.js", - "line": 229, + "line": 248, "description": "Delegate a series of requests based on a snapshot, relationship, and a change.\nThe change argument can be 'delete', 'remove', 'update', 'add', 'create'", "itemtype": "method", "name": "_handleRelatedRequest", @@ -2499,7 +2732,7 @@ }, { "file": "addon/authenticators/osf-cookie.js", - "line": 61, + "line": 60, "description": "For now, simply verify that a token is present and can be used", "itemtype": "method", "name": "authenticate", @@ -2545,23 +2778,23 @@ "submodule": "components" }, { - "file": "addon/components/osf-navbar/component.js", - "line": 27, - "description": "Whether search icons and functionality show up", + "file": "addon/components/navbar-auth-dropdown/component.js", + "line": 33, + "description": "The URL to use for signup. May be overridden, eg for special campaign pages", "itemtype": "property", - "name": "hideSearch", - "type": "{Boolean}", - "class": "osf-navbar", + "name": "signupUrl", + "type": "{String}", + "class": "navbar-auth-dropdown", "module": "ember-osf", "submodule": "components" }, { "file": "addon/components/osf-navbar/component.js", - "line": 34, - "description": "The URL to use for signup. May be overridden, eg for special campaign pages", + "line": 26, + "description": "Whether search icons and functionality show up", "itemtype": "property", - "name": "signupUrl", - "type": "{String}", + "name": "hideSearch", + "type": "{Boolean}", "class": "osf-navbar", "module": "ember-osf", "submodule": "components" @@ -2579,14 +2812,15 @@ }, { "file": "addon/const/permissions.js", - "line": 5, + "line": 14, "description": "Provide human-readable labels for permissions fields. Useful in dropdown UI.", "itemtype": "property", "name": "permissionSelector", "final": 1, - "type": "{*[]}", - "class": "elem-id", - "module": "ember-osf" + "type": "{Object[]}", + "class": "permissions", + "module": "ember-osf", + "submodule": "const" }, { "file": "addon/mixins/cas-authenticated-route.js", @@ -3243,18 +3477,18 @@ { "file": "addon/mixins/node-actions.js", "line": 199, - "description": "Add a node link (pointer) to another node", + "description": "Adds a relationship to another node, called a linkedNode.", "itemtype": "method", "name": "addNodeLink", "params": [ { "name": "targetNodeId", - "description": "ID of the node for which you wish to create a pointer", + "description": "ID of the node for which you wish to create a link", "type": "String" } ], "return": { - "description": "Returns a promise that resolves to model for the newly created NodeLink", + "description": "Returns a promise that resolves to the newly updated node", "type": "Promise" }, "class": "NodeActionsMixin", @@ -3264,18 +3498,18 @@ { "file": "addon/mixins/node-actions.js", "line": 214, - "description": "Remove a node link (pointer) to another node", + "description": "Removes the linkedNode relationship to another node. Does not remove the linked node itself.", "itemtype": "method", "name": "removeNodeLink", "params": [ { - "name": "nodeLink", - "description": "nodeLink record to be destroyed.", + "name": "linkedNode", + "description": "linkedNode relationship to be destroyed.", "type": "Object" } ], "return": { - "description": "Returns a promise that resolves after the node link has been removed. This does not delete\nthe target node itself.", + "description": "Returns a promise that resolves to the newly updated node", "type": "Promise" }, "class": "NodeActionsMixin", @@ -3555,7 +3789,7 @@ }, { "file": "addon/models/node.js", - "line": 83, + "line": 106, "description": "Is this a project? Flag can be used to provide template-specific behavior for different resource types.", "itemtype": "property", "name": "isProject", @@ -3566,7 +3800,7 @@ }, { "file": "addon/models/node.js", - "line": 89, + "line": 112, "description": "Is this a registration? Flag can be used to provide template-specific behavior for different resource types.", "itemtype": "property", "name": "isRegistration", @@ -3577,7 +3811,7 @@ }, { "file": "addon/models/node.js", - "line": 96, + "line": 119, "description": "Is this node being viewed through an anonymized, view-only link?", "itemtype": "property", "name": "isAnonymous", @@ -3588,7 +3822,7 @@ }, { "file": "addon/models/node.js", - "line": 103, + "line": 126, "description": "Determine whether the specified user ID is a contributor on this node", "itemtype": "method", "name": "isContributor", @@ -4396,12 +4630,28 @@ "class": "auth", "module": "ember-osf", "submodule": "utils" - } - ], - "warnings": [ + }, { - "message": "replacing incorrect tag: returns with return", - "line": " addon/models/node.js:103" + "file": "addon/utils/fix-special-char.js", + "line": 10, + "description": "This function is useful for fixing a bad API behavior. In certain cases the server will insert HTML escape\nsequences into text, and this will replace `&` sequences with `&`. Template helper and ember-data field versions\nof this function are available.", + "itemtype": "method", + "name": "fixSpecialChar", + "params": [ + { + "name": "inputString", + "description": "A string value to be transformed", + "type": "String" + } + ], + "return": { + "description": "", + "type": "String|null" + }, + "class": "fix-special-char", + "module": "ember-osf", + "submodule": "utils" } - ] + ], + "warnings": [] } \ No newline at end of file diff --git a/docs/files/addon_adapters_osf-adapter.js.html b/docs/files/addon_adapters_osf-adapter.js.html index 5e183e276..261149501 100644 --- a/docs/files/addon_adapters_osf-adapter.js.html +++ b/docs/files/addon_adapters_osf-adapter.js.html @@ -2,7 +2,7 @@ - addon/adapters/osf-adapter.js - Ember OSF + addon/adapters/osf-adapter.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -185,9 +194,28 @@

File: addon/adapters/osf-adapter.js

* @uses GenericDataAdapterMixin */ export default DS.JSONAPIAdapter.extend(HasManyQuery.RESTAdapterMixin, GenericDataAdapterMixin, { + headers: { + ACCEPT: 'application/vnd.api+json; version=2.3' + }, authorizer: config['ember-simple-auth'].authorizer, host: config.OSF.apiUrl, namespace: config.OSF.apiNamespace, + /** + * Overrides buildQuery method - Allows users to embed resources with findRecord + * OSF APIv2 does not have "include" functionality, instead we use 'embed'. + * Usage: findRecord(type, id, {include: 'resource'}) or findRecord(type, id, {include: ['resource1', resource2]}) + * Swaps included resources with embedded resources + * + * @method buildQuery + */ + buildQuery() { + let query = this._super(...arguments); + if (query.include) { + query.embed = query.include; + } + delete query.include; + return query; + }, buildURL(modelName, id, snapshot, requestType) { var url = this._super(...arguments); var options = (snapshot ? snapshot.adapterOptions : false) || {}; @@ -382,7 +410,7 @@

File: addon/adapters/osf-adapter.js

data: data, isBulk: isBulk }).then(res => { - if (!Ember.$.isArray(res.data)) { + if (res && !Ember.$.isArray(res.data)) { res.data = [res.data]; } return res; diff --git a/docs/files/addon_authenticators_osf-cookie.js.html b/docs/files/addon_authenticators_osf-cookie.js.html index 3ffc0d648..a92a75ee8 100644 --- a/docs/files/addon_authenticators_osf-cookie.js.html +++ b/docs/files/addon_authenticators_osf-cookie.js.html @@ -2,7 +2,7 @@ - addon/authenticators/osf-cookie.js - Ember OSF + addon/authenticators/osf-cookie.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -213,8 +222,7 @@

File: addon/authenticators/osf-cookie.js

// Can't do this via AJAX request because it redirects to CAS, and AJAX + redirect = CORS issue // Manually clear session before user leaves the page, since we aren't sticking around for ESA to do so later - this.get('session.session')._clear(true) - .then(() => window.location = `${config.OSF.url}logout/`); + return this.get('session.session')._clear(true); } else { // This branch is expected to be called when a test request reveals the user to lack permissions... so session should be wiped return Ember.RSVP.resolve(); diff --git a/docs/files/addon_authenticators_osf-token.js.html b/docs/files/addon_authenticators_osf-token.js.html index de33b00e8..397b38d08 100644 --- a/docs/files/addon_authenticators_osf-token.js.html +++ b/docs/files/addon_authenticators_osf-token.js.html @@ -2,7 +2,7 @@ - addon/authenticators/osf-token.js - Ember OSF + addon/authenticators/osf-token.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_authorizers_osf-cookie.js.html b/docs/files/addon_authorizers_osf-cookie.js.html index 168f7ff57..4e9368b06 100644 --- a/docs/files/addon_authorizers_osf-cookie.js.html +++ b/docs/files/addon_authorizers_osf-cookie.js.html @@ -2,7 +2,7 @@ - addon/authorizers/osf-cookie.js - Ember OSF + addon/authorizers/osf-cookie.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_authorizers_osf-token.js.html b/docs/files/addon_authorizers_osf-token.js.html index b4175a088..a4c1be6e6 100644 --- a/docs/files/addon_authorizers_osf-token.js.html +++ b/docs/files/addon_authorizers_osf-token.js.html @@ -2,7 +2,7 @@ - addon/authorizers/osf-token.js - Ember OSF + addon/authorizers/osf-token.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_citation-widget_component.js.html b/docs/files/addon_components_citation-widget_component.js.html new file mode 100644 index 000000000..b5b13d621 --- /dev/null +++ b/docs/files/addon_components_citation-widget_component.js.html @@ -0,0 +1,244 @@ + + + + + addon/components/citation-widget/component.js - Ember OSF Addon + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2.0 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

File: addon/components/citation-widget/component.js

+ +
+ 
+import Ember from 'ember';
+import layout from './template';
+
+/**
+ * @module ember-osf
+ * @submodule components
+ */
+
+const citationStyles = [
+    {
+        linkSuffix: 'apa',
+        attr: 'apa'
+    },
+    {
+        linkSuffix: 'chicago-author-date',
+        attr: 'chicago'
+    },
+    {
+        linkSuffix: 'modern-language-association',
+        attr: 'mla'
+    }
+];
+
+/**
+ * Lists citations for node in APA, MLA, and Chicago formats
+ *
+ * @class citation-widget
+ * @param {node} node for which to fetch citations
+ */
+export default Ember.Component.extend({
+    layout,
+    apa: null,
+    chicago: null,
+    mla: null,
+    node: null,
+    store: Ember.inject.service(),
+
+    didRender() {
+        const node = this.get('node');
+
+        if (!node) {
+            return;
+        }
+
+        const citationLink = node.get('links.relationships.citation.links.related.href');
+
+        for (const { linkSuffix, attr } of citationStyles) {
+            this.get('store')
+                .adapterFor('node')
+                .ajax(`${citationLink}${linkSuffix}/`, 'GET')
+                .then(resp => this.set(attr, resp.data.attributes.citation));
+        }
+    }
+});
+
+
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/files/addon_components_comment-detail_component.js.html b/docs/files/addon_components_comment-detail_component.js.html index 3315b743f..db07c0a9b 100644 --- a/docs/files/addon_components_comment-detail_component.js.html +++ b/docs/files/addon_components_comment-detail_component.js.html @@ -2,7 +2,7 @@ - addon/components/comment-detail/component.js - Ember OSF + addon/components/comment-detail/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_comment-form_component.js.html b/docs/files/addon_components_comment-form_component.js.html index af5d68bbd..c669ea031 100644 --- a/docs/files/addon_components_comment-form_component.js.html +++ b/docs/files/addon_components_comment-form_component.js.html @@ -2,7 +2,7 @@ - addon/components/comment-form/component.js - Ember OSF + addon/components/comment-form/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_comment-pane_component.js.html b/docs/files/addon_components_comment-pane_component.js.html index 88a6f0960..5354b9e0f 100644 --- a/docs/files/addon_components_comment-pane_component.js.html +++ b/docs/files/addon_components_comment-pane_component.js.html @@ -2,7 +2,7 @@ - addon/components/comment-pane/component.js - Ember OSF + addon/components/comment-pane/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_dropzone-widget_component.js.html b/docs/files/addon_components_dropzone-widget_component.js.html index e91bb1d9c..4c02f3d54 100644 --- a/docs/files/addon_components_dropzone-widget_component.js.html +++ b/docs/files/addon_components_dropzone-widget_component.js.html @@ -2,7 +2,7 @@ - addon/components/dropzone-widget/component.js - Ember OSF + addon/components/dropzone-widget/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_eosf-project-nav_component.js.html b/docs/files/addon_components_eosf-project-nav_component.js.html index 20a931bb7..00b74ec36 100644 --- a/docs/files/addon_components_eosf-project-nav_component.js.html +++ b/docs/files/addon_components_eosf-project-nav_component.js.html @@ -2,7 +2,7 @@ - addon/components/eosf-project-nav/component.js - Ember OSF + addon/components/eosf-project-nav/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_file-browser-icon_component.js.html b/docs/files/addon_components_file-browser-icon_component.js.html index 9f3d48324..9ed4253cb 100644 --- a/docs/files/addon_components_file-browser-icon_component.js.html +++ b/docs/files/addon_components_file-browser-icon_component.js.html @@ -2,7 +2,7 @@ - addon/components/file-browser-icon/component.js - Ember OSF + addon/components/file-browser-icon/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_file-browser-item_component.js.html b/docs/files/addon_components_file-browser-item_component.js.html index 9eaf0d8b3..93d94b4ef 100644 --- a/docs/files/addon_components_file-browser-item_component.js.html +++ b/docs/files/addon_components_file-browser-item_component.js.html @@ -2,7 +2,7 @@ - addon/components/file-browser-item/component.js - Ember OSF + addon/components/file-browser-item/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_file-browser_component.js.html b/docs/files/addon_components_file-browser_component.js.html index 7a83729b2..28dcc9282 100644 --- a/docs/files/addon_components_file-browser_component.js.html +++ b/docs/files/addon_components_file-browser_component.js.html @@ -2,7 +2,7 @@ - addon/components/file-browser/component.js - Ember OSF + addon/components/file-browser/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_file-chooser_component.js.html b/docs/files/addon_components_file-chooser_component.js.html index 3b419aa36..bb8bbfc23 100644 --- a/docs/files/addon_components_file-chooser_component.js.html +++ b/docs/files/addon_components_file-chooser_component.js.html @@ -2,7 +2,7 @@ - addon/components/file-chooser/component.js - Ember OSF + addon/components/file-chooser/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_file-renderer_component.js.html b/docs/files/addon_components_file-renderer_component.js.html index 3e011825a..93756c472 100644 --- a/docs/files/addon_components_file-renderer_component.js.html +++ b/docs/files/addon_components_file-renderer_component.js.html @@ -2,7 +2,7 @@ - addon/components/file-renderer/component.js - Ember OSF + addon/components/file-renderer/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_file-version_component.js.html b/docs/files/addon_components_file-version_component.js.html index 8298cb7cb..21ec97d1b 100644 --- a/docs/files/addon_components_file-version_component.js.html +++ b/docs/files/addon_components_file-version_component.js.html @@ -2,7 +2,7 @@ - addon/components/file-version/component.js - Ember OSF + addon/components/file-version/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_file-widget_component.js.html b/docs/files/addon_components_file-widget_component.js.html index 4a9a5d7a9..b0695d386 100644 --- a/docs/files/addon_components_file-widget_component.js.html +++ b/docs/files/addon_components_file-widget_component.js.html @@ -2,7 +2,7 @@ - addon/components/file-widget/component.js - Ember OSF + addon/components/file-widget/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_navbar-auth-dropdown_component.js.html b/docs/files/addon_components_navbar-auth-dropdown_component.js.html new file mode 100644 index 000000000..52bd55aab --- /dev/null +++ b/docs/files/addon_components_navbar-auth-dropdown_component.js.html @@ -0,0 +1,262 @@ + + + + + addon/components/navbar-auth-dropdown/component.js - Ember OSF Addon + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2.0 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

File: addon/components/navbar-auth-dropdown/component.js

+ +
+ 
+import Ember from 'ember';
+import layout from './template';
+import config from 'ember-get-config';
+
+/**
+ * @module ember-osf
+ * @submodule components
+ */
+
+/**
+ * Display the login dropdown on the navbar
+ *
+ * Sample usage:
+ * ```handlebars
+ * {{navbar-auth-dropdown
+ *   loginAction=loginAction
+ *   redirectUrl=redirectUrl}}
+ * ```
+ *
+ * @class navbar-auth-dropdown
+ */
+export default Ember.Component.extend({
+    layout,
+    session: Ember.inject.service(),
+    currentUser: Ember.inject.service(),
+
+    tagName: 'li',
+    classNames: ['dropdown'],
+    classNameBindings: ['notAuthenticated:sign-in'],
+    notAuthenticated: Ember.computed.not('session.isAuthenticated'),
+    redirectUrl: null,
+
+    /**
+     * The URL to use for signup. May be overridden, eg for special campaign pages
+     *
+     * @property signupUrl
+     * @type {String}
+     */
+    signupUrl: config.OSF.url + 'register',
+
+    gravatarUrl: Ember.computed('user', function() {
+        let imgLink = this.get('user.links.profile_image');
+
+        return imgLink ? `${imgLink}&s=25` : '';
+    }),
+    host: config.OSF.url,
+    user: null,
+    _loadCurrentUser() {
+        this.get('currentUser')
+            .load()
+            .then(user => this.set('user', user));
+    },
+    init() {
+        this._super(...arguments);
+        // TODO: React to changes in service/ event?
+        if (this.get('session.isAuthenticated')) {
+            this._loadCurrentUser();
+        }
+    },
+    // TODO: These parameters are defined in osf settings.py; make sure ember config matches.
+    allowLogin: true,
+    enableInstitutions: true,
+    actions: {
+        logout() {
+            const redirectUrl = this.get('redirectUrl');
+            const query = redirectUrl ? '?' + Ember.$.param({ redirect_url: redirectUrl }) : '';
+            // TODO: May not work well if logging out from page that requires login- check?
+            this.get('session').invalidate()
+                .then(() => window.location.href = `${config.OSF.url}logout/${query}`);
+        },
+    }
+});
+
+
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/files/addon_components_oauth-popup_component.js.html b/docs/files/addon_components_oauth-popup_component.js.html index 5581ba2d8..2d86c0ab3 100644 --- a/docs/files/addon_components_oauth-popup_component.js.html +++ b/docs/files/addon_components_oauth-popup_component.js.html @@ -2,7 +2,7 @@ - addon/components/oauth-popup/component.js - Ember OSF + addon/components/oauth-popup/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_osf-copyright_component.js.html b/docs/files/addon_components_osf-copyright_component.js.html index 72732dfd8..d35c38fa3 100644 --- a/docs/files/addon_components_osf-copyright_component.js.html +++ b/docs/files/addon_components_osf-copyright_component.js.html @@ -2,7 +2,7 @@ - addon/components/osf-copyright/component.js - Ember OSF + addon/components/osf-copyright/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -173,7 +182,8 @@

File: addon/components/osf-copyright/component.js

* @class osf-copyright */ export default Ember.Component.extend({ - layout + layout, + currentYear: (new Date()).getUTCFullYear().toString() }); diff --git a/docs/files/addon_components_osf-footer_component.js.html b/docs/files/addon_components_osf-footer_component.js.html index 68d28c7fb..86cec9510 100644 --- a/docs/files/addon_components_osf-footer_component.js.html +++ b/docs/files/addon_components_osf-footer_component.js.html @@ -2,7 +2,7 @@ - addon/components/osf-footer/component.js - Ember OSF + addon/components/osf-footer/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_osf-mode-footer_component.js.html b/docs/files/addon_components_osf-mode-footer_component.js.html index 1d804a97d..6a9313a96 100644 --- a/docs/files/addon_components_osf-mode-footer_component.js.html +++ b/docs/files/addon_components_osf-mode-footer_component.js.html @@ -2,7 +2,7 @@ - addon/components/osf-mode-footer/component.js - Ember OSF + addon/components/osf-mode-footer/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_osf-navbar_component.js.html b/docs/files/addon_components_osf-navbar_component.js.html index d93a55790..8a6a266e1 100644 --- a/docs/files/addon_components_osf-navbar_component.js.html +++ b/docs/files/addon_components_osf-navbar_component.js.html @@ -2,7 +2,7 @@ - addon/components/osf-navbar/component.js - Ember OSF + addon/components/osf-navbar/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -184,7 +193,6 @@

File: addon/components/osf-navbar/component.js

export default Ember.Component.extend({ layout, session: Ember.inject.service(), - currentUser: Ember.inject.service(), onSearchPage: false, /** * Whether search icons and functionality show up @@ -193,46 +201,14 @@

File: addon/components/osf-navbar/component.js

*/ hideSearch: false, - /** - * The URL to use for signup. May be overridden, eg for special campaign pages - * - * @property signupUrl - * @type {String} - */ - signupUrl: config.OSF.url + 'register', - - gravatarUrl: Ember.computed('user', function() { - let imgLink = this.get('user.links.profile_image'); - if (imgLink) { - imgLink += '&s=25'; - } - return imgLink; - }), - fullName: null, host: config.OSF.url, - user: null, + showSearch: false, - _loadCurrentUser() { - this.get('currentUser').load().then((user) => this.set('user', user)); - }, - init() { - this._super(...arguments); - // TODO: React to changes in service/ event? - if (this.get('session.isAuthenticated')) { - this._loadCurrentUser(); - } - }, - // TODO: These parameters are defined in osf settings.py; make sure ember config matches. - allowLogin: true, - enableInstitutions: true, + actions: { toggleSearch() { this.toggleProperty('showSearch'); }, - logout() { - // TODO: May not work well if logging out from page that requires login- check? - this.get('session').invalidate(); - }, } }); diff --git a/docs/files/addon_components_osf-paginator_component.js.html b/docs/files/addon_components_osf-paginator_component.js.html index 0d9ceeaf5..fbd17a537 100644 --- a/docs/files/addon_components_osf-paginator_component.js.html +++ b/docs/files/addon_components_osf-paginator_component.js.html @@ -2,7 +2,7 @@ - addon/components/osf-paginator/component.js - Ember OSF + addon/components/osf-paginator/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_pagination-control_component.js.html b/docs/files/addon_components_pagination-control_component.js.html index 1cb529401..dc8b975b9 100644 --- a/docs/files/addon_components_pagination-control_component.js.html +++ b/docs/files/addon_components_pagination-control_component.js.html @@ -2,7 +2,7 @@ - addon/components/pagination-control/component.js - Ember OSF + addon/components/pagination-control/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_search-dropdown_component.js.html b/docs/files/addon_components_search-dropdown_component.js.html index 13fae458c..5574d3c4a 100644 --- a/docs/files/addon_components_search-dropdown_component.js.html +++ b/docs/files/addon_components_search-dropdown_component.js.html @@ -2,7 +2,7 @@ - addon/components/search-dropdown/component.js - Ember OSF + addon/components/search-dropdown/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_sign-up_component.js.html b/docs/files/addon_components_sign-up_component.js.html index 51012d64d..bf5831ccc 100644 --- a/docs/files/addon_components_sign-up_component.js.html +++ b/docs/files/addon_components_sign-up_component.js.html @@ -2,7 +2,7 @@ - addon/components/sign-up/component.js - Ember OSF + addon/components/sign-up/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_components_tags-widget_component.js.html b/docs/files/addon_components_tags-widget_component.js.html index ddb073b20..6b3c2d47a 100644 --- a/docs/files/addon_components_tags-widget_component.js.html +++ b/docs/files/addon_components_tags-widget_component.js.html @@ -2,7 +2,7 @@ - addon/components/tags-widget/component.js - Ember OSF + addon/components/tags-widget/component.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_const_permissions.js.html b/docs/files/addon_const_permissions.js.html index 386687081..fe83958f2 100644 --- a/docs/files/addon_const_permissions.js.html +++ b/docs/files/addon_const_permissions.js.html @@ -2,7 +2,7 @@ - addon/const/permissions.js - Ember OSF + addon/const/permissions.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -164,14 +173,23 @@

File: addon/const/permissions.js

var READ = 'read'; var WRITE = 'write'; +/** + * @module ember-osf + * @submodule const + */ + +/** + * @class permissions + */ + /** * Provide human-readable labels for permissions fields. Useful in dropdown UI. * @property permissionSelector * @final - * @type {*[]} + * @type {Object[]} */ // TODO: Document constants in YUIDoc format -let permissionSelector = [ +const permissionSelector = [ { value: READ, text: 'Read' }, { value: WRITE, text: 'Read + Write' }, { value: ADMIN, text: 'Administrator' } diff --git a/docs/files/addon_helpers_elem-id.js.html b/docs/files/addon_helpers_elem-id.js.html index 2b4104d92..d3280e4bb 100644 --- a/docs/files/addon_helpers_elem-id.js.html +++ b/docs/files/addon_helpers_elem-id.js.html @@ -2,7 +2,7 @@ - addon/helpers/elem-id.js - Ember OSF + addon/helpers/elem-id.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_helpers_fix-special-char.js.html b/docs/files/addon_helpers_fix-special-char.js.html new file mode 100644 index 000000000..5b7b0ada6 --- /dev/null +++ b/docs/files/addon_helpers_fix-special-char.js.html @@ -0,0 +1,209 @@ + + + + + addon/helpers/fix-special-char.js - Ember OSF Addon + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2.0 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

File: addon/helpers/fix-special-char.js

+ +
+ 
+import Ember from 'ember';
+import fixSpecialChar from '../utils/fix-special-char';
+
+/**
+ Apply the `fix-special-char` utility function to clean up malformed text sent from the server.
+
+ Usage example:
+ ```handlebars
+    This is text we want to fix: {{fix-special-char 'Now & then'}}
+  ```
+
+  @class fix-special-char-helper
+  @uses fix-special-char
+ */
+export function fixSpecialCharHelper(params/*, hash*/) {
+    return params ? fixSpecialChar(params[0]) : params;
+}
+
+export default Ember.Helper.helper(fixSpecialCharHelper);
+
+
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/files/addon_mixins_cas-authenticated-route.js.html b/docs/files/addon_mixins_cas-authenticated-route.js.html index 12f612b63..7ac4625e4 100644 --- a/docs/files/addon_mixins_cas-authenticated-route.js.html +++ b/docs/files/addon_mixins_cas-authenticated-route.js.html @@ -2,7 +2,7 @@ - addon/mixins/cas-authenticated-route.js - Ember OSF + addon/mixins/cas-authenticated-route.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_commentable.js.html b/docs/files/addon_mixins_commentable.js.html index 872c7f93a..ca23ef037 100644 --- a/docs/files/addon_mixins_commentable.js.html +++ b/docs/files/addon_mixins_commentable.js.html @@ -2,7 +2,7 @@ - addon/mixins/commentable.js - Ember OSF + addon/mixins/commentable.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_fetch-all-route.js.html b/docs/files/addon_mixins_fetch-all-route.js.html index 6863bbfbf..07468727e 100644 --- a/docs/files/addon_mixins_fetch-all-route.js.html +++ b/docs/files/addon_mixins_fetch-all-route.js.html @@ -2,7 +2,7 @@ - addon/mixins/fetch-all-route.js - Ember OSF + addon/mixins/fetch-all-route.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_file-cache-bypass.js.html b/docs/files/addon_mixins_file-cache-bypass.js.html index 90deb04a1..ed937f99f 100644 --- a/docs/files/addon_mixins_file-cache-bypass.js.html +++ b/docs/files/addon_mixins_file-cache-bypass.js.html @@ -2,7 +2,7 @@ - addon/mixins/file-cache-bypass.js - Ember OSF + addon/mixins/file-cache-bypass.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_file-item.js.html b/docs/files/addon_mixins_file-item.js.html index e8dfa7dbb..d5909c224 100644 --- a/docs/files/addon_mixins_file-item.js.html +++ b/docs/files/addon_mixins_file-item.js.html @@ -2,7 +2,7 @@ - addon/mixins/file-item.js - Ember OSF + addon/mixins/file-item.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_generic-data-adapter.js.html b/docs/files/addon_mixins_generic-data-adapter.js.html index 512232012..0f7d8dbf9 100644 --- a/docs/files/addon_mixins_generic-data-adapter.js.html +++ b/docs/files/addon_mixins_generic-data-adapter.js.html @@ -2,7 +2,7 @@ - addon/mixins/generic-data-adapter.js - Ember OSF + addon/mixins/generic-data-adapter.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_infinity-custom.js.html b/docs/files/addon_mixins_infinity-custom.js.html index 4d8ee77d8..498a8e8cb 100644 --- a/docs/files/addon_mixins_infinity-custom.js.html +++ b/docs/files/addon_mixins_infinity-custom.js.html @@ -2,7 +2,7 @@ - addon/mixins/infinity-custom.js - Ember OSF + addon/mixins/infinity-custom.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_node-actions.js.html b/docs/files/addon_mixins_node-actions.js.html index 6ddea6d22..674452c8f 100644 --- a/docs/files/addon_mixins_node-actions.js.html +++ b/docs/files/addon_mixins_node-actions.js.html @@ -2,7 +2,7 @@ - addon/mixins/node-actions.js - Ember OSF + addon/mixins/node-actions.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -359,31 +368,33 @@

File: addon/mixins/node-actions.js

return this.get('_node').addChild(title, description, category); }, /** - * Add a node link (pointer) to another node + * Adds a relationship to another node, called a linkedNode. * * @method addNodeLink - * @param {String} targetNodeId ID of the node for which you wish to create a pointer - * @return {Promise} Returns a promise that resolves to model for the newly created NodeLink + * @param {String} targetNodeId ID of the node for which you wish to create a link + * @return {Promise} Returns a promise that resolves to the newly updated node */ addNodeLink(targetNodeId) { var node = this.get('_node'); - var nodeLink = this.store.createRecord('node-link', { - target: targetNodeId + return this.store.findRecord('node', targetNodeId).then(linkedNode => { + node.get('linkedNodes').pushObject(linkedNode); + return node.save(); }); - node.get('nodeLinks').pushObject(nodeLink); - return node.save().then(() => nodeLink); + }, /** - * Remove a node link (pointer) to another node + * Removes the linkedNode relationship to another node. Does not remove the linked node itself. * * @method removeNodeLink - * @param {Object} nodeLink nodeLink record to be destroyed. - * @return {Promise} Returns a promise that resolves after the node link has been removed. This does not delete - * the target node itself. + * @param {Object} linkedNode linkedNode relationship to be destroyed. + * @return {Promise} Returns a promise that resolves to the newly updated node */ - removeNodeLink(nodeLink) { - return nodeLink.destroyRecord(); + removeNodeLink(linkedNode) { + var node = this.get('_node'); + node.get('linkedNodes').removeObject(linkedNode); + return node.save(); } + } }); diff --git a/docs/files/addon_mixins_osf-agnostic-auth-controller.js.html b/docs/files/addon_mixins_osf-agnostic-auth-controller.js.html index 8a90ce8c8..5115bf5f8 100644 --- a/docs/files/addon_mixins_osf-agnostic-auth-controller.js.html +++ b/docs/files/addon_mixins_osf-agnostic-auth-controller.js.html @@ -2,7 +2,7 @@ - addon/mixins/osf-agnostic-auth-controller.js - Ember OSF + addon/mixins/osf-agnostic-auth-controller.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_osf-agnostic-auth-route.js.html b/docs/files/addon_mixins_osf-agnostic-auth-route.js.html index b7538dbfc..dc6b0f08b 100644 --- a/docs/files/addon_mixins_osf-agnostic-auth-route.js.html +++ b/docs/files/addon_mixins_osf-agnostic-auth-route.js.html @@ -2,7 +2,7 @@ - addon/mixins/osf-agnostic-auth-route.js - Ember OSF + addon/mixins/osf-agnostic-auth-route.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_osf-cookie-login-controller.js.html b/docs/files/addon_mixins_osf-cookie-login-controller.js.html index dbf8f501a..efe5051b7 100644 --- a/docs/files/addon_mixins_osf-cookie-login-controller.js.html +++ b/docs/files/addon_mixins_osf-cookie-login-controller.js.html @@ -2,7 +2,7 @@ - addon/mixins/osf-cookie-login-controller.js - Ember OSF + addon/mixins/osf-cookie-login-controller.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_osf-cookie-login-route.js.html b/docs/files/addon_mixins_osf-cookie-login-route.js.html index fa88ac4ef..0c000f92c 100644 --- a/docs/files/addon_mixins_osf-cookie-login-route.js.html +++ b/docs/files/addon_mixins_osf-cookie-login-route.js.html @@ -2,7 +2,7 @@ - addon/mixins/osf-cookie-login-route.js - Ember OSF + addon/mixins/osf-cookie-login-route.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_osf-token-login-controller.js.html b/docs/files/addon_mixins_osf-token-login-controller.js.html index 639f9b0ae..298aec760 100644 --- a/docs/files/addon_mixins_osf-token-login-controller.js.html +++ b/docs/files/addon_mixins_osf-token-login-controller.js.html @@ -2,7 +2,7 @@ - addon/mixins/osf-token-login-controller.js - Ember OSF + addon/mixins/osf-token-login-controller.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_osf-token-login-route.js.html b/docs/files/addon_mixins_osf-token-login-route.js.html index 9f271d648..d01a75749 100644 --- a/docs/files/addon_mixins_osf-token-login-route.js.html +++ b/docs/files/addon_mixins_osf-token-login-route.js.html @@ -2,7 +2,7 @@ - addon/mixins/osf-token-login-route.js - Ember OSF + addon/mixins/osf-token-login-route.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_paginated-controller.js.html b/docs/files/addon_mixins_paginated-controller.js.html index 682afaeea..ed582233b 100644 --- a/docs/files/addon_mixins_paginated-controller.js.html +++ b/docs/files/addon_mixins_paginated-controller.js.html @@ -2,7 +2,7 @@ - addon/mixins/paginated-controller.js - Ember OSF + addon/mixins/paginated-controller.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_paginated-route.js.html b/docs/files/addon_mixins_paginated-route.js.html index a1d01e1a9..dcce49599 100644 --- a/docs/files/addon_mixins_paginated-route.js.html +++ b/docs/files/addon_mixins_paginated-route.js.html @@ -2,7 +2,7 @@ - addon/mixins/paginated-route.js - Ember OSF + addon/mixins/paginated-route.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_registration-actions.js.html b/docs/files/addon_mixins_registration-actions.js.html index 52190cdb0..7c2c46f1a 100644 --- a/docs/files/addon_mixins_registration-actions.js.html +++ b/docs/files/addon_mixins_registration-actions.js.html @@ -2,7 +2,7 @@ - addon/mixins/registration-actions.js - Ember OSF + addon/mixins/registration-actions.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_mixins_taggable-mixin.js.html b/docs/files/addon_mixins_taggable-mixin.js.html index 7d5f5b14a..c1af67059 100644 --- a/docs/files/addon_mixins_taggable-mixin.js.html +++ b/docs/files/addon_mixins_taggable-mixin.js.html @@ -2,7 +2,7 @@ - addon/mixins/taggable-mixin.js - Ember OSF + addon/mixins/taggable-mixin.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_models_citation.js.html b/docs/files/addon_models_citation.js.html new file mode 100644 index 000000000..4a8697245 --- /dev/null +++ b/docs/files/addon_models_citation.js.html @@ -0,0 +1,207 @@ + + + + + addon/models/citation.js - Ember OSF Addon + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2.0 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

File: addon/models/citation.js

+ +
+ 
+import DS from 'ember-data';
+
+import OsfModel from './osf-model';
+
+/**
+ * @module ember-osf
+ * @submodule models
+ */
+
+/**
+ * Model for OSF APIv2 citation styles
+ *
+ * @class Citation
+ */
+export default OsfModel.extend({
+    citation: DS.attr('string')
+});
+
+
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/files/addon_models_collection.js.html b/docs/files/addon_models_collection.js.html index 12b77024d..a12f17ff0 100644 --- a/docs/files/addon_models_collection.js.html +++ b/docs/files/addon_models_collection.js.html @@ -2,7 +2,7 @@ - addon/models/collection.js - Ember OSF + addon/models/collection.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -177,16 +186,17 @@

File: addon/models/collection.js

* @class Collection */ export default OsfModel.extend({ - title: DS.attr('string'), + title: DS.attr('fixstring'), dateCreated: DS.attr('date'), dateModified: DS.attr('date'), bookmarks: DS.attr('boolean'), - // nodeLinks: DS.hasMany('node-links', { - // inverse:null - // }), linkedNodes: DS.hasMany('nodes', { inverse: null, serializerType: 'linked-node' + }), + linkedRegistrations: DS.hasMany('registrations', { + inverse: null, + serializerType: 'linked-node' }) }); diff --git a/docs/files/addon_models_comment-report.js.html b/docs/files/addon_models_comment-report.js.html index 69aeadd57..7f827345a 100644 --- a/docs/files/addon_models_comment-report.js.html +++ b/docs/files/addon_models_comment-report.js.html @@ -2,7 +2,7 @@ - addon/models/comment-report.js - Ember OSF + addon/models/comment-report.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -177,7 +186,7 @@

File: addon/models/comment-report.js

* @class CommentReport */ export default OsfModel.extend({ - category: DS.attr('string'), + category: DS.attr('fixstring'), text: DS.belongsTo('comment') }); diff --git a/docs/files/addon_models_comment.js.html b/docs/files/addon_models_comment.js.html index 8235edb79..2d1e5e7f3 100644 --- a/docs/files/addon_models_comment.js.html +++ b/docs/files/addon_models_comment.js.html @@ -2,7 +2,7 @@ - addon/models/comment.js - Ember OSF + addon/models/comment.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -181,13 +190,13 @@

File: addon/models/comment.js

*/ export default OsfModel.extend({ // TODO validation: maxLength - content: DS.attr('string'), - page: DS.attr('string'), + content: DS.attr('fixstring'), + page: DS.attr('fixstring'), // Placeholder for comment creation: allow specifying attributes that are sent to the server, but not as attributes // Both type and ID will be serialized into relationships field - targetID: DS.attr('string'), - targetType: DS.attr('string'), + targetID: DS.attr('fixstring'), + targetType: DS.attr('fixstring'), // TODO dynamic belongsTo user: DS.belongsTo('user'), diff --git a/docs/files/addon_models_contributor.js.html b/docs/files/addon_models_contributor.js.html index 83ee5e8a6..cc537bcd3 100644 --- a/docs/files/addon_models_contributor.js.html +++ b/docs/files/addon_models_contributor.js.html @@ -2,7 +2,7 @@ - addon/models/contributor.js - Ember OSF + addon/models/contributor.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -178,7 +187,7 @@

File: addon/models/contributor.js

*/ export default OsfModel.extend({ bibliographic: DS.attr('boolean'), - permission: DS.attr('string'), + permission: DS.attr('fixstring'), _userId: null, userId: Ember.computed('_userId', { @@ -208,10 +217,10 @@

File: addon/models/contributor.js

}).volatile(), users: DS.belongsTo('user'), - unregisteredContributor: DS.attr('string'), + unregisteredContributor: DS.attr('fixstring'), index: DS.attr('number'), - fullName: DS.attr('string'), - email: DS.attr('string'), + fullName: DS.attr('fixstring'), + email: DS.attr('fixstring'), sendEmail: DS.attr('boolean'), node: DS.belongsTo('node', { diff --git a/docs/files/addon_models_draft-registration.js.html b/docs/files/addon_models_draft-registration.js.html index 73c4b4d42..249bb1217 100644 --- a/docs/files/addon_models_draft-registration.js.html +++ b/docs/files/addon_models_draft-registration.js.html @@ -2,7 +2,7 @@ - addon/models/draft-registration.js - Ember OSF + addon/models/draft-registration.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -177,7 +186,7 @@

File: addon/models/draft-registration.js

* @class DraftRegistration */ export default OsfModel.extend({ - registrationSupplement: DS.attr('string'), + registrationSupplement: DS.attr('fixstring'), registrationMetadata: DS.attr(), datetimeInitiated: DS.attr('date'), datetimeUpdated: DS.attr('date'), diff --git a/docs/files/addon_models_file-provider.js.html b/docs/files/addon_models_file-provider.js.html index d063122a5..edc18a5d2 100644 --- a/docs/files/addon_models_file-provider.js.html +++ b/docs/files/addon_models_file-provider.js.html @@ -2,7 +2,7 @@ - addon/models/file-provider.js - Ember OSF + addon/models/file-provider.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -182,10 +191,10 @@

File: addon/models/file-provider.js

export default OsfModel.extend(FileItemMixin, { isProvider: true, - name: DS.attr('string'), - kind: DS.attr('string'), + name: DS.attr('fixstring'), + kind: DS.attr('fixstring'), path: DS.attr('string'), - provider: DS.attr('string'), + provider: DS.attr('fixstring'), files: DS.hasMany('file'), node: DS.belongsTo('node') }); diff --git a/docs/files/addon_models_file-version.js.html b/docs/files/addon_models_file-version.js.html index e99f4a931..e3dee4153 100644 --- a/docs/files/addon_models_file-version.js.html +++ b/docs/files/addon_models_file-version.js.html @@ -2,7 +2,7 @@ - addon/models/file-version.js - Ember OSF + addon/models/file-version.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -179,7 +188,7 @@

File: addon/models/file-version.js

*/ export default OsfModel.extend({ size: DS.attr('number'), - contentType: DS.attr('string') + contentType: DS.attr('fixstring') }); diff --git a/docs/files/addon_models_file.js.html b/docs/files/addon_models_file.js.html index c46a18cbe..65448f471 100644 --- a/docs/files/addon_models_file.js.html +++ b/docs/files/addon_models_file.js.html @@ -2,7 +2,7 @@ - addon/models/file.js - Ember OSF + addon/models/file.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -185,13 +194,13 @@

File: addon/models/file.js

export default OsfModel.extend(FileItemMixin, { _isFileModel: true, - name: DS.attr('string'), - kind: DS.attr('string'), - guid: DS.attr('string'), + name: DS.attr('fixstring'), + kind: DS.attr('fixstring'), + guid: DS.attr('fixstring'), path: DS.attr('string'), size: DS.attr('number'), currentVersion: DS.attr('number'), - provider: DS.attr('string'), + provider: DS.attr('fixstring'), materializedPath: DS.attr('string'), lastTouched: DS.attr('date'), dateModified: DS.attr('date'), @@ -208,7 +217,7 @@

File: addon/models/file.js

versions: DS.hasMany('file-version'), comments: DS.hasMany('comment'), node: DS.belongsTo('node'), // TODO: In the future apiv2 may also need to support this pointing at nodes OR registrations - checkout: DS.attr('string') + checkout: DS.attr('fixstring') }); diff --git a/docs/files/addon_models_institution.js.html b/docs/files/addon_models_institution.js.html index bb2717fa8..17c207e21 100644 --- a/docs/files/addon_models_institution.js.html +++ b/docs/files/addon_models_institution.js.html @@ -2,7 +2,7 @@ - addon/models/institution.js - Ember OSF + addon/models/institution.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -181,8 +190,8 @@

File: addon/models/institution.js

* @class Institution */ export default OsfModel.extend({ - name: DS.attr('string'), - description: DS.attr('string'), + name: DS.attr('fixstring'), + description: DS.attr('fixstring'), logoPath: DS.attr('string'), authUrl: DS.attr('string'), diff --git a/docs/files/addon_models_log.js.html b/docs/files/addon_models_log.js.html index ba3d3f62c..8907dd080 100644 --- a/docs/files/addon_models_log.js.html +++ b/docs/files/addon_models_log.js.html @@ -2,7 +2,7 @@ - addon/models/log.js - Ember OSF + addon/models/log.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -180,7 +189,7 @@

File: addon/models/log.js

*/ export default OsfModel.extend({ date: DS.attr('date'), - action: DS.attr('string'), + action: DS.attr('fixstring'), params: DS.attr(), node: DS.belongsTo('node', { inverse: null diff --git a/docs/files/addon_models_metaschema.js.html b/docs/files/addon_models_metaschema.js.html index 5fbd11e7e..4456592c2 100644 --- a/docs/files/addon_models_metaschema.js.html +++ b/docs/files/addon_models_metaschema.js.html @@ -2,7 +2,7 @@ - addon/models/metaschema.js - Ember OSF + addon/models/metaschema.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -179,7 +188,7 @@

File: addon/models/metaschema.js

*/ export default OsfModel.extend({ - name: DS.attr('string'), + name: DS.attr('fixstring'), schemaVersion: DS.attr('number'), schema: DS.attr() }); diff --git a/docs/files/addon_models_node-link.js.html b/docs/files/addon_models_node-link.js.html index 8202e6f39..f002e8470 100644 --- a/docs/files/addon_models_node-link.js.html +++ b/docs/files/addon_models_node-link.js.html @@ -2,7 +2,7 @@ - addon/models/node-link.js - Ember OSF + addon/models/node-link.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_models_node.js.html b/docs/files/addon_models_node.js.html index 5078e08ea..016cb72a6 100644 --- a/docs/files/addon_models_node.js.html +++ b/docs/files/addon_models_node.js.html @@ -2,7 +2,7 @@ - addon/models/node.js - Ember OSF + addon/models/node.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -186,11 +195,12 @@

File: addon/models/node.js

export default OsfModel.extend(FileItemMixin, { isNode: true, - title: DS.attr('string'), - description: DS.attr('string'), - category: DS.attr('string'), + title: DS.attr('fixstring'), + description: DS.attr('fixstring'), + category: DS.attr('fixstring'), - currentUserPermissions: DS.attr('string'), + // List of strings + currentUserPermissions: DS.attr(), fork: DS.attr('boolean'), collection: DS.attr('boolean'), @@ -200,9 +210,12 @@

File: addon/models/node.js

dateCreated: DS.attr('date'), dateModified: DS.attr('date'), + forkedDate: DS.attr('date'), + + nodeLicense: DS.attr(), tags: DS.attr(), - templateFrom: DS.attr('string'), + templateFrom: DS.attr('fixstring'), parent: DS.belongsTo('node', { inverse: 'children' @@ -222,11 +235,17 @@

File: addon/models/node.js

allowBulkRemove: true, inverse: 'node' }), + citation: DS.belongsTo('citation'), + + license: DS.belongsTo('license', { + inverse: null + }), files: DS.hasMany('file-provider'), //forkedFrom: DS.belongsTo('node'), - nodeLinks: DS.hasMany('node-links', { - inverse: null + linkedNodes: DS.hasMany('nodes', { + inverse: null, + serializerType: 'linked-node' }), registrations: DS.hasMany('registrations', { inverse: 'registeredFrom' @@ -236,9 +255,22 @@

File: addon/models/node.js

inverse: 'branchedFrom' }), + forks: DS.hasMany('nodes', { + inverse: 'forkedFrom' + }), + + forkedFrom: DS.belongsTo('node', { + inverse: 'forks' + }), + root: DS.belongsTo('node', { inverse: null }), + + wikis: DS.hasMany('wikis', { + inverse: 'node' + }), + logs: DS.hasMany('logs'), // These are only computeds because maintaining separate flag values on different classes would be a headache TODO: Improve. @@ -266,7 +298,7 @@

File: addon/models/node.js

* Determine whether the specified user ID is a contributor on this node * @method isContributor * @param {String} userId - * @returns {boolean} Whether the specified user is a contributor on this node + * @return {boolean} Whether the specified user is a contributor on this node */ isContributor(userId) { // Return true if there is at least one matching contributor for this user ID diff --git a/docs/files/addon_models_osf-model.js.html b/docs/files/addon_models_osf-model.js.html index ecbe7a9fa..feb7cde41 100644 --- a/docs/files/addon_models_osf-model.js.html +++ b/docs/files/addon_models_osf-model.js.html @@ -2,7 +2,7 @@ - addon/models/osf-model.js - Ember OSF + addon/models/osf-model.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_models_preprint.js.html b/docs/files/addon_models_preprint.js.html index 9630028f0..026d6080e 100644 --- a/docs/files/addon_models_preprint.js.html +++ b/docs/files/addon_models_preprint.js.html @@ -2,7 +2,7 @@ - addon/models/preprint.js - Ember OSF + addon/models/preprint.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -178,18 +187,21 @@

File: addon/models/preprint.js

* @class Preprint */ export default OsfModel.extend({ - title: DS.attr('string'), + + title: DS.attr('fixstring'), // TODO: May be a relationship in the future pending APIv2 changes subjects: DS.attr(), dateCreated: DS.attr('date'), datePublished: DS.attr('date'), - dateModifed: DS.attr('date'), - doi: DS.attr('string'), + dateModified: DS.attr('date'), + doi: DS.attr('fixstring'), isPublished: DS.attr('boolean'), isPreprintOrphan: DS.attr('boolean'), + licenseRecord: DS.attr(), // Relationships node: DS.belongsTo('node', { inverse: null, async: true }), + license: DS.belongsTo('license', { inverse: null }), primaryFile: DS.belongsTo('file', { inverse: null }), provider: DS.belongsTo('preprint-provider', { inverse: 'preprints', async: true }), }); diff --git a/docs/files/addon_models_registration.js.html b/docs/files/addon_models_registration.js.html index bc1b2f88a..88c12dc22 100644 --- a/docs/files/addon_models_registration.js.html +++ b/docs/files/addon_models_registration.js.html @@ -2,7 +2,7 @@ - addon/models/registration.js - Ember OSF + addon/models/registration.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -186,10 +195,10 @@

File: addon/models/registration.js

embargoEndDate: DS.attr('date'), pendingEmbargoApproval: DS.attr('boolean'), withdrawn: DS.attr('boolean'), - withdrawalJustification: DS.attr('string'), + withdrawalJustification: DS.attr('fixstring'), pendingWithdrawal: DS.attr('boolean'), - registrationSupplement: DS.attr('string'), + registrationSupplement: DS.attr('fixstring'), registeredMeta: DS.attr(), registeredFrom: DS.belongsTo('node', { @@ -200,8 +209,8 @@

File: addon/models/registration.js

}), contributors: DS.hasMany('contributors'), comments: DS.hasMany('comments'), - draftRegistration: DS.attr('string'), - registrationChoice: DS.attr('string'), + draftRegistration: DS.attr('fixstring'), + registrationChoice: DS.attr('fixstring'), liftEmbargo: DS.attr() //more relationship }); diff --git a/docs/files/addon_models_taxonomy.js.html b/docs/files/addon_models_taxonomy.js.html index 8254ddebe..3ea6adbd4 100644 --- a/docs/files/addon_models_taxonomy.js.html +++ b/docs/files/addon_models_taxonomy.js.html @@ -2,7 +2,7 @@ - addon/models/taxonomy.js - Ember OSF + addon/models/taxonomy.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -175,7 +184,7 @@

File: addon/models/taxonomy.js

* @class Taxonomy */ export default OsfModel.extend({ - text: DS.attr('string'), + text: DS.attr('fixstring'), // TODO: Api implements this as a list field for now. This should be a relationship field in the future, when API supports it child_count: DS.attr(), parents: DS.attr() diff --git a/docs/files/addon_models_user.js.html b/docs/files/addon_models_user.js.html index 0b0e12e4f..17a783d2f 100644 --- a/docs/files/addon_models_user.js.html +++ b/docs/files/addon_models_user.js.html @@ -2,7 +2,7 @@ - addon/models/user.js - Ember OSF + addon/models/user.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -180,14 +189,14 @@

File: addon/models/user.js

* @class User */ export default OsfModel.extend({ - fullName: DS.attr('string'), - givenName: DS.attr('string'), + fullName: DS.attr('fixstring'), + givenName: DS.attr('fixstring'), middleNames: DS.attr(), - familyName: DS.attr('string'), + familyName: DS.attr('fixstring'), dateRegistered: DS.attr('date'), // email - username: DS.attr('string'), + username: DS.attr('fixstring'), nodes: DS.hasMany('nodes'), registrations: DS.hasMany('registrations'), diff --git a/docs/files/addon_serializers_osf-serializer.js.html b/docs/files/addon_serializers_osf-serializer.js.html index 82264a662..39a01ba87 100644 --- a/docs/files/addon_serializers_osf-serializer.js.html +++ b/docs/files/addon_serializers_osf-serializer.js.html @@ -2,7 +2,7 @@ - addon/serializers/osf-serializer.js - Ember OSF + addon/serializers/osf-serializer.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -202,6 +211,9 @@

File: addon/serializers/osf-serializer.js

} //TODO Pagination probably breaks here let data = resourceHash.embeds[embedded].data || resourceHash.embeds[embedded]; + if (!('errors' in data)) { + this.store.pushPayload({ data }); + } if (Array.isArray(data)) { included = included.concat(data); } else { @@ -274,11 +286,11 @@

File: addon/serializers/osf-serializer.js

}, normalizeArrayResponse(store, primaryModelClass, payload, id, requestType) { // jshint ignore:line - // Ember data does not yet support pagination. For any request that returns more than one result, extract - // links.meta from the payload links section, and add to the model metadata manually. + // Ember data does not yet support pagination. For any request that returns more than one result, add pagination data + // under meta, and then calculate total pages to be loaded. let documentHash = this._super(...arguments); documentHash.meta = documentHash.meta || {}; - documentHash.meta.pagination = Ember.get(payload || {}, 'links.meta'); + documentHash.meta.pagination = Ember.$.extend(true, {}, Ember.get(payload || {}, 'meta')); documentHash.meta.total = Math.ceil(documentHash.meta.pagination.total / documentHash.meta.pagination.per_page); return documentHash; } diff --git a/docs/files/addon_services_current-user.js.html b/docs/files/addon_services_current-user.js.html index 0e7a75f59..657346003 100644 --- a/docs/files/addon_services_current-user.js.html +++ b/docs/files/addon_services_current-user.js.html @@ -2,7 +2,7 @@ - addon/services/current-user.js - Ember OSF + addon/services/current-user.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_services_file-manager.js.html b/docs/files/addon_services_file-manager.js.html index 03dc38a3c..5789561a4 100644 --- a/docs/files/addon_services_file-manager.js.html +++ b/docs/files/addon_services_file-manager.js.html @@ -2,7 +2,7 @@ - addon/services/file-manager.js - Ember OSF + addon/services/file-manager.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_transforms_fixstring.js.html b/docs/files/addon_transforms_fixstring.js.html new file mode 100644 index 000000000..a2dedd2ea --- /dev/null +++ b/docs/files/addon_transforms_fixstring.js.html @@ -0,0 +1,220 @@ + + + + + addon/transforms/fixstring.js - Ember OSF Addon + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2.0 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

File: addon/transforms/fixstring.js

+ +
+ 
+import DS from 'ember-data';
+
+import fixSpecialChars from '../utils/fix-special-char';
+
+/**
+ * @module ember-osf
+ * @submodule transforms
+ */
+
+/**
+  Custom string field transform that uses the `fix-special-char` utility function to clean up malformed text sent
+  from the server. This allows string fields to be correctly and transparently used in templates without manually fixing
+  these characters for display on each use.
+
+   This transform is used when `fixstring` is passed as the type parameter to the DS.attr function.
+    ```app/models/score.js
+     import DS from 'ember-data';
+     export default DS.Model.extend({
+        astring: DS.attr('fixstring'),
+     });
+   ```
+  @class fixstring
+  @extends DS.StringTransform
+  @uses fix-special-char
+ */
+export default DS.StringTransform.extend({
+    deserialize(serialized) {
+        return fixSpecialChars(this._super(serialized));
+    }
+});
+
+
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/files/addon_utils_ajax-helpers.js.html b/docs/files/addon_utils_ajax-helpers.js.html index d4e44e329..777b5974d 100644 --- a/docs/files/addon_utils_ajax-helpers.js.html +++ b/docs/files/addon_utils_ajax-helpers.js.html @@ -2,7 +2,7 @@ - addon/utils/ajax-helpers.js - Ember OSF + addon/utils/ajax-helpers.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/files/addon_utils_auth.js.html b/docs/files/addon_utils_auth.js.html index ae81c9cb4..f55bbb0cc 100644 --- a/docs/files/addon_utils_auth.js.html +++ b/docs/files/addon_utils_auth.js.html @@ -2,7 +2,7 @@ - addon/utils/auth.js - Ember OSF + addon/utils/auth.js - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -202,7 +211,7 @@

File: addon/utils/auth.js

*/ function getCookieAuthUrl(nextUri) { nextUri = nextUri || config.OSF.redirectUri; - let loginUri = `${config.OSF.url}login?next=${encodeURIComponent(nextUri)}`; + const loginUri = `${config.OSF.url}login/?next=${encodeURIComponent(nextUri)}`; return `${config.OSF.cookieLoginUrl}?service=${encodeURIComponent(loginUri)}`; } diff --git a/docs/files/addon_utils_fix-special-char.js.html b/docs/files/addon_utils_fix-special-char.js.html new file mode 100644 index 000000000..276d9d295 --- /dev/null +++ b/docs/files/addon_utils_fix-special-char.js.html @@ -0,0 +1,213 @@ + + + + + addon/utils/fix-special-char.js - Ember OSF Addon + + + + + + + + +
+
+
+

+
+
+ API Docs for: 0.2.0 +
+
+
+ +
+ +
+
+
+ Show: + + + + + + + +
+ +
+
+
+

File: addon/utils/fix-special-char.js

+ +
+ 
+/**
+ * @module ember-osf
+ * @submodule utils
+ */
+
+/**
+ * @class fix-special-char
+ */
+
+/**
+ * This function is useful for fixing a bad API behavior. In certain cases the server will insert HTML escape
+ * sequences into text, and this will replace `&` sequences with `&`. Template helper and ember-data field versions
+ * of this function are available.
+ *
+ * @method fixSpecialChar
+ * @param {String} inputString A string value to be transformed
+ * @return {String|null}
+ */
+export default function fixSpecialChar(inputString) {
+    return inputString ? inputString.replace(/&/g, '&') : inputString;
+}
+
+export { fixSpecialChar };
+
+
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/docs/index.html b/docs/index.html index 6286c96f4..08595a8d4 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@ - Ember OSF + Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/modules/adapters.html b/docs/modules/adapters.html index dab4aa866..c463a9657 100644 --- a/docs/modules/adapters.html +++ b/docs/modules/adapters.html @@ -2,7 +2,7 @@ - adapters - Ember OSF + adapters - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/modules/authenticators.html b/docs/modules/authenticators.html index 4a34aaf78..0b9722f19 100644 --- a/docs/modules/authenticators.html +++ b/docs/modules/authenticators.html @@ -2,7 +2,7 @@ - authenticators - Ember OSF + authenticators - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/modules/authorizers.html b/docs/modules/authorizers.html index 2e329cd25..9f67413bb 100644 --- a/docs/modules/authorizers.html +++ b/docs/modules/authorizers.html @@ -2,7 +2,7 @@ - authorizers - Ember OSF + authorizers - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
diff --git a/docs/modules/components.html b/docs/modules/components.html index 00ffc873e..ddba87f63 100644 --- a/docs/modules/components.html +++ b/docs/modules/components.html @@ -2,7 +2,7 @@ - components - Ember OSF + components - Ember OSF Addon @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.0.1 + API Docs for: 0.2.0
@@ -168,16 +177,7 @@

components Module

-

Display information about an individual comment, including controls to edit, delete, and report. -This component is typically used as part of the comment-pane component; see that component for further information.

-

Sample usage:

-
{{comment-detail
-  comment=comment
-  editComment=attrs.editComment
-  deleteComment=attrs.deleteComment
-  restoreComment=attrs.restoreComment
-  reportComment=attrs.reportComment}}
-
+

Lists citations for node in APA, MLA, and Chicago formats

@@ -187,6 +187,11 @@

components Module

This module provides the following classes:

@@ -161,7 +170,7 @@

ember-osf Module

- Defined in: addon/utils/auth.js:10 + Defined in: addon/utils/fix-special-char.js:6
@@ -188,6 +197,16 @@

ember-osf Module

CasAuthenticatedRouteMixin +
  • + + Citation + +
    • +
  • + + citation-widget + +
  • Collection @@ -318,6 +337,21 @@

    ember-osf Module

    FileVersion
    • +
  • + + fix-special-char + +
    • +
  • + + fix-special-char-helper + +
    • +
  • + + fixstring + +
  • GenericDataADapter @@ -343,6 +377,11 @@

    ember-osf Module

    Metaschema
    • +
  • + + navbar-auth-dropdown + +
  • Node @@ -463,6 +502,11 @@

    ember-osf Module

    pagination-control
    • +
  • + + permissions + +
  • Registration @@ -543,18 +587,16 @@

    ember-osf Module
    - Display information about an individual comment, including controls to edit, delete, and report. -This component is typically used as part of the comment-pane component; see that component for further information. + Lists citations for node in APA, MLA, and Chicago formats +
    +
    • +
  • + + const + -Sample usage: -`handlebars -{{comment-detail - comment=comment - editComment=attrs.editComment - deleteComment=attrs.deleteComment - restoreComment=attrs.restoreComment - reportComment=attrs.reportComment}} -` +
    +
  • @@ -586,9 +628,7 @@

    ember-osf Module

    - Model for OSF APIv2 collections -For field and usage information, see: -* https://api.osf.io/v2/docs/#!/v2/Collection_List_GET + Model for OSF APIv2 citation styles
  • @@ -609,6 +649,25 @@

    ember-osf Module

    Access information about the currently logged in user
    • +
  • + + transforms + + +
    + Custom string field transform that uses the fix-special-char utility function to clean up malformed text sent +from the server. This allows string fields to be correctly and transparently used in templates without manually fixing +these characters for display on each use. + + This transform is used when fixstring is passed as the type parameter to the DS.attr function. + `app/models/score.js + import DS from 'ember-data'; + export default DS.Model.extend({ + astring: DS.attr('fixstring'), + }); + ` +
    +
    • diff --git a/docs/modules/ember-preprints.html b/docs/modules/ember-preprints.html index f96d613f7..9bc6783de 100644 --- a/docs/modules/ember-preprints.html +++ b/docs/modules/ember-preprints.html @@ -2,7 +2,7 @@ - ember-preprints - Ember OSF + ember-preprints - Ember OSF Addon @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.0.1 + API Docs for: 0.2.0
    diff --git a/docs/modules/ember.html b/docs/modules/ember.html index 6ad639901..e61925437 100644 --- a/docs/modules/ember.html +++ b/docs/modules/ember.html @@ -2,7 +2,7 @@ - ember - Ember OSF + ember - Ember OSF Addon @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.0.1 + API Docs for: 0.2.0
    diff --git a/docs/modules/helpers.html b/docs/modules/helpers.html index e52626739..cd8866ec1 100644 --- a/docs/modules/helpers.html +++ b/docs/modules/helpers.html @@ -2,7 +2,7 @@ - helpers - Ember OSF + helpers - Ember OSF Addon @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.0.1 + API Docs for: 0.2.0
    diff --git a/docs/modules/mixins.html b/docs/modules/mixins.html index 383c6ca4c..c10fde5ef 100644 --- a/docs/modules/mixins.html +++ b/docs/modules/mixins.html @@ -2,7 +2,7 @@ - mixins - Ember OSF + mixins - Ember OSF Addon @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.0.1 + API Docs for: 0.2.0
    diff --git a/docs/modules/models.html b/docs/modules/models.html index 84d76a732..f21a281a0 100644 --- a/docs/modules/models.html +++ b/docs/modules/models.html @@ -2,7 +2,7 @@ - models - Ember OSF + models - Ember OSF Addon @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.0.1 + API Docs for: 0.2.0
    @@ -168,11 +177,7 @@

    models Module

    -

    Model for OSF APIv2 collections -For field and usage information, see:

    - +

    Model for OSF APIv2 citation styles

    @@ -182,6 +187,11 @@

    models Module

    This module provides the following classes:

    diff --git a/docs/modules/services.html b/docs/modules/services.html index f1bd58b85..2181ebb84 100644 --- a/docs/modules/services.html +++ b/docs/modules/services.html @@ -2,7 +2,7 @@ - services - Ember OSF + services - Ember OSF Addon @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.0.1 + API Docs for: 0.2.0
    diff --git a/docs/modules/transforms.html b/docs/modules/transforms.html new file mode 100644 index 000000000..b5995047a --- /dev/null +++ b/docs/modules/transforms.html @@ -0,0 +1,225 @@ + + + + + transforms - Ember OSF Addon + + + + + + + + +
    +
    +
    +

    +
    +
    + API Docs for: 0.2.0 +
    +
    +
    + +
    + +
    +
    +
    + Show: + + + + + + + +
    + +
    +
    +
    +

    transforms Module

    +
    + + +
    + Defined in: addon/transforms/fixstring.js:10 +
    + +
    + + +
    +

    Custom string field transform that uses the fix-special-char utility function to clean up malformed text sent +from the server. This allows string fields to be correctly and transparently used in templates without manually fixing +these characters for display on each use.

    +

    This transform is used when fixstring is passed as the type parameter to the DS.attr function.

    +
     import DS from 'ember-data';
+ export default DS.Model.extend({
+    astring: DS.attr('fixstring'),
+ });
+
    + +
    + + +
    +
    +

    This module provides the following classes:

    + + +
    + + +
    +
    +
    +
    +
    +
    +
    +
    +
    + + + + + + + + + + diff --git a/docs/modules/utils.html b/docs/modules/utils.html index 93e47900b..a1198f4c8 100644 --- a/docs/modules/utils.html +++ b/docs/modules/utils.html @@ -2,7 +2,7 @@ - utils - Ember OSF + utils - Ember OSF Addon @@ -14,10 +14,10 @@ @@ -188,6 +197,11 @@

    utils Module

    auth +
  • + + fix-special-char + +