# @667/js-owncloud-client > ownCloud client library for JavaScript Latest version **0.1.11** (published 2021-11-22) · MIT license · 0 weekly downloads ## Install ```sh npm install @667/js-owncloud-client pnpm add @667/js-owncloud-client yarn add @667/js-owncloud-client bun add @667/js-owncloud-client ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.11 | | Published | 2021-11-22 | | First published | 2021-06-15 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 6 | | Unpacked size | 3.4 MB | | Known vulnerabilities | 0 (+23 in 1 direct dependencies) | | Install scripts | no | | Author | June07 | | Maintainers | 667 | | Keywords | owncloud, api, ownCloud, javascript, client, node, nodejs, js, promise | ## Links - npm: https://www.npmjs.com/package/@667/js-owncloud-client - Repository: https://github.com/june07/owncloud-sdk - Homepage: https://github.com/june07/owncloud-sdk#readme - Issues: https://github.com/june07/owncloud-sdk/issues - npm.io page: https://npm.io/package/@667/js-owncloud-client ## Dependencies (6) - [utf8](https://npm.io/package/utf8.md) ^3.0.0 - [axios](https://npm.io/package/axios.md) ^0.21.1 - [xml-js](https://npm.io/package/xml-js.md) ^1.6.11 - [promise](https://npm.io/package/promise.md) ^8.1.0 - [form-data](https://npm.io/package/form-data.md) ^4.0.0 - [axios-retry](https://npm.io/package/axios-retry.md) ^3.1.9 ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 0.1.11 (latest) — 2021-11-22 - 0.1.10 — 2021-08-18 - 0.1.9 — 2021-08-18 - 0.1.8 — 2021-08-18 - 0.1.7 — 2021-08-18 - 0.1.6 — 2021-08-18 - 0.1.5 — 2021-06-19 - 0.1.4 — 2021-06-16 - 0.1.3-v3 — 2021-06-16 - 0.1.3-v2 — 2021-06-16 - 0.1.3-v1 — 2021-06-15 - 0.1.3 — 2021-06-15 ## README [![Build Status](https://travis-ci.org/owncloud/js-owncloud-client.svg?branch=master)](https://travis-ci.org/noveens/js-owncloud-client) [![Dependencies Status](https://david-dm.org/noveens/js-owncloud-client.svg)](https://david-dm.org/noveens/js-owncloud-client.svg) [![devDependencies Status](https://david-dm.org/noveens/js-owncloud-client/dev-status.svg)](https://david-dm.org/noveens/js-owncloud-client?type=dev)

The main purpose of this form was to update the deps (mainly request which is now deprecated) and axios, axios-retry, and form-data basically take the place of the request package. Further the node-lts branch is the primary branch of concern as owncloud sdk in general is designed to run in the browser not node. ## Install ``` $ npm install js-owncloud-client ``` ## Usage ### Node.JS ```js var owncloud = require('js-owncloud-client'); var oc = new owncloud('*owncloud instance URL*'); // Login oc.login('username', 'password').then(status => { // STUFF }).catch(error => { // HANDLE ERROR }); // Share File With Link oc.shares.shareFileWithLink('linkToYourFile').then(shareInfo => { console.log("Link is : " + shareInfo.getLink()); }).catch(error => { // HANDLE ERROR }); // List all files oc.files.list('/path/to/file/folder').then(files => { console.log(files); }).catch(error => { console.log(error); }); ``` ### Browser ```html ``` ## Example Projects ### Node.JS Based ### Browser Based A sample text-file saving and retreiving static web app which uses this library: link ## All Methods Available ### General ```js var owncloud = require('js-owncloud-client'); var oc = new owncloud('*owncloud instance URL*'); ``` Method | Code ----------------|------------------------------ setInstance | `oc.setInstance(instance)` login | `oc.login(username, password)` getConfig | `oc.getConfig()` getVersion | `oc.getVersion()` getCapabilities | `oc.getCapabilities()` ### Files Management ```js var owncloud = require('js-owncloud-client'); var oc = new owncloud('*owncloud instance URL*'); ``` Method | Code ------------------|---------------------------------------------------- list | `oc.files.list(/path/to/file/folder, depth)` getFileContents | `oc.files.getFileContents(path/to/file/folder)` putFileContents | `oc.files.putFileContents(path/to/file, contents)` mkdir | `oc.files.mkdir(path/to/folder)` createFolder | `oc.files.createFolder(path/to/folder)` delete | `oc.files.delete(path/to/file/folder)` fileInfo | `oc.files.fileInfo(path/to/file/folder)` getFile | `oc.files.getFile(remotePath, localPath)` getDirectoryAsZip | `oc.files.getDirectoryAsZip(remotePath, localPath)` putFile | `oc.files.putFile(remotePath, localPath)` putDirectory | `oc.files.putDirectory(remotePath, localPath)` move | `oc.files.move(source, target)` copy | `oc.files.copy(source, target)` ### Apps Management ```js var owncloud = require('js-owncloud-client'); var oc = new owncloud('*owncloud instance URL*'); ``` Method | Code ----------------|---------------------------------------- getApps | `oc.apps.getApps()` getAttribute | `oc.apps.getAttribute(app, key)` setAttribute | `oc.apps.setAttribute(app, key, value)` deleteAttribute | `oc.apps.deleteAttribute(app, key)` enableApp | `oc.apps.enableApp(appName)` disableApp | `oc.apps.disableApp(appName)` ### Group Management ```js var owncloud = require('js-owncloud-client'); var oc = new owncloud('*owncloud instance URL*'); ``` Method | Code ----------------|--------------------------------------- createGroup | `oc.groups.createGroup(groupName)` deleteGroup | `oc.groups.deleteGroup(groupName)` getGroups | `oc.groups.getGroups()` getGroupMembers | `oc.groups.getGroupMembers(groupName)` groupExists | `oc.groups.groupExists(groupName)` ### Share Management ```js var owncloud = require('js-owncloud-client'); var oc = new owncloud('*owncloud instance URL*'); ``` Method | Code --------------------|---------------------------------------------------------------------------------------------------- shareFileWithLink | `oc.shares.shareFileWithLink(path, {perms: perms, publicUpload: publicUpload, password: password})` updateShare | `oc.shares.updateShare(shareId, {perms: perms, publicUpload: publicUpload, password: password})` shareFileWithUser | `oc.shares.shareFileWithUser(path, username, {perms: perms, remoteUser: remoteUser })` shareFileWithGroup | `oc.shares.shareFileWithGroup(path, groupname, {perms: perms })` getShares | `oc.shares.getShares()` isShared | `oc.shares.isShared(path/to/file/folder)` getShare | `oc.shares.getShare(shareId)` listOpenRemoteShare | `oc.shares.listOpenRemoteShare()` acceptRemoteShare | `oc.shares.acceptRemoteShare(shareId)` declineRemoteShare | `oc.shares.declineRemoteShare(shareId)` deleteShare | `oc.shares.deleteShare(shareId)` ### User Management ```js var owncloud = require('js-owncloud-client'); var oc = new owncloud('*owncloud instance URL*'); ``` Method | Code -----------------------|------------------------------------------------------ createUser | `oc.users.createUser(username, password)` deleteUser | `oc.users.deleteUser(username)` searchUsers | `oc.users.searchUsers(searchKey)` userExists | `oc.users.userExists(username)` getUsers | `oc.users.getUsers()` setUserAttribute | `oc.users.setUserAttribute(username, key, value)` addUserToGroup | `oc.users.addUserToGroup(username, groupName)` getUserGroups | `oc.users.getUserGroups(username)` userIsInGroup | `oc.users.userIsInGroup(username, groupName)` getUser | `oc.users.getUser(username)` removeUserFromGroup | `oc.users.removeUserFromGroup(username, groupName)` addUserToSubadminGroup | `oc.users.addUserToSubadminGroup(username, groupName)` getUserSubadminGroups | `oc.users.getUserSubadminGroups(username)` userIsInSubadminGroup | `oc.users.userIsInSubadminGroup(username, groupName)` ## Building the Documentation ### Swagger Documentation Stuck? Just type this to see all the above available methods live in action in your browser!
``` $ cd node_modules/js-owncloud-client/ $ make swagger ``` If you open the link showed by running the above command, you will see something like this : Here, you can click on any method and type in values, to experiment with the methods in the browser itself!
Now isn't that cool? :wink: ### JSDocs To build the jsdocs, type this command and follow the instructions on the terminal : ``` $ cd node_modules/js-owncloud-client/ $ make jsdocs ``` ## Unit tests The following command will run all unit tests. Before running the command, make sure you have edited the `owncloud/test/config.json` file accordingly. ``` $ cd node_modules/js-owncloud-client/ $ make test ``` ## Team [![Noveen Sachdeva](http://gravatar.com/avatar/fb09a21ff4cb473d6cf5e70c5fc0f751?s=144)](https://github.com/noveens)         [![Vincent Petry](https://avatars1.githubusercontent.com/u/277525?v=3&s=144)](https://github.com/PVince81)
Noveen Sachdeva             Vincent Petry # ![GSoC'17](http://cltk.org/assets/GSoC2016Logo.jpg) --- _Source: https://npm.io/package/@667/js-owncloud-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._