studio-helper v1.18.1

Classes

Typedefs

StudioHelper

Kind: global class

• Classes
• Typedefs
• StudioHelper
  • new StudioHelper(settings)
  • studioHelper.login(username, password, token, [longSession]) ⇒ Promise
  • studioHelper.updateSessionSetting(setting, value)
  • studioHelper.resetSessionSettings()
  • studioHelper.getAllFolders([limit], [offset]) ⇒ Promise.\<ApiResponse.\<Array.\<{id: string, name: string, parentId: (null|string), createdAt: number, modifiedAt: number}>>>
  • studioHelper.getMetadataFields() ⇒ Promise.\<ApiResponse.\<Array.\<{id: string, fields: {id: string, type: string, names: Object}, languages: Array.\<string>}>>>
  • studioHelper.getConversions() ⇒ Promise.\<ApiResponse.\<Array.\<{id: string, name: string}>>>
  • studioHelper.push(settings) ⇒ Array.\<Object>
  • studioHelper.createDirectoryFolders(folderData) ⇒ Array.\<ResultObj>
  • studioHelper.getLocalFolders(path) ⇒ Array.\<string>
  • studioHelper.getFiles(folderId) ⇒ Promise.\<Array.\<Object>>
  • studioHelper.deleteFiles(files, options) ⇒ Promise.\<Object>
  • studioHelper.uploadFiles(files, folderId) ⇒ Promise.\<Array.\<Object>>
  • studioHelper.replaceFiles(files, [options]) ⇒ Promise.\<Array.\<Object>>
  • studioHelper.getFileHeaders(fileId) ⇒ ResultObj
  • studioHelper.setFileHeaders(fileId, headerSettings, [options]) ⇒ ResultObj
  • studioHelper.getUploadInformation(files, folderId) ⇒ Array.\<Object>
  • studioHelper.getReplaceInformation(files, options)
  • studioHelper.getFolders([parentId]) ⇒ Promise.\<Object>
  • studioHelper.createFolder(settings) ⇒ ResultObj
  • studioHelper.deleteFolder(folderId) ⇒ Promise.\<Object>
  • studioHelper.deleteChildFolders(folderId) ⇒ Promise.\<Object>
  • studioHelper.getFolderSettings(folderId) ⇒ ResultObj
  • studioHelper.updateFolderSettings(folderId, folderSettings, [options]) ⇒ ResultObj
  • studioHelper.batchUpload(files) ⇒ Array.\<object>
• ApiResponse : Object
• ResultObj : Object
• ProgressOptions
• FileHeaderSettings : Object
• CreateFolderResult : Object
• FolderSettings : Object
• FolderUpdateSettings : Object

new StudioHelper(settings)

Example

var StudioHelper = require('studio-helper'),
    studio = new StudioHelper({
      studio: 'xyz.studio.crasman.fi',
      proxy: 'http://xyz.intra:8080/'
    });

studioHelper.login(username, password, token, longSession) ⇒ Promise

Login

Kind: instance method of StudioHelper

studioHelper.updateSessionSetting(setting, value)

Update a single setting for this session

See documentation for available settings.

Kind: instance method of StudioHelper
See: Documentation

studioHelper.resetSessionSettings()

Reset all API settings to default values

Kind: instance method of StudioHelper

studioHelper.getAllFolders(limit, offset) ⇒ Promise.<ApiResponse.<Array.<{id: string, name: string, parentId: (null|string), createdAt: number, modifiedAt: number}>>>

Get all folders in Studio

Kind: instance method of StudioHelper

studioHelper.getMetadataFields() ⇒ Promise.<ApiResponse.<Array.<{id: string, fields: {id: string, type: string, names: Object}, languages: Array.<string>}>>>

Get all metadata fields defined in Stage for this Studio

Kind: instance method of StudioHelper
Example
return value

// {
//   "status": "ok",
//   "result": [
//     {
//       "id": "my_table",
//       "fields": [
//         {
//           "id": "my_field",
//           "type": "st",
//           "names": {
//             "en": "My field"
//           }
//         }
//       ],
//       "languages": [
//         "en"
//       ]
//     }
//   ],
//   "code": 0
// }

studioHelper.getConversions() ⇒ Promise.<ApiResponse.<Array.<{id: string, name: string}>>>

Kind: instance method of StudioHelper
Example
return value

// {
//   "status": "ok",
//   "result": [
//     {
//       "id": "my_conversion",
//       "name": "My conversion",
//     }
//   ],
//   "code": 0
// }

studioHelper.push(settings) ⇒ Array.<Object>

Push changes to Studio

Kind: instance method of StudioHelper
Returns: Array.<Object> - Array of objects with file upload information. Array has data property which contains additional information.

Example

studio.push({
  folders: [{
    folderId: '568a7a2aadd4532b0f4f4f5b',
    localFolder: 'dist/js'
  }, {
    folderId: '568a7a27add453aa1a4f4f58',
    localFolder: 'dist/css'
  }, {
    folderId: '568a7a27add453aa1a4f4f58',
    localFolder: 'dist/',
    includeSubFolders: true,
    createNewFileVersions: false,
    createdFolderSettings: {
      'dist/master': { // Regex match
        cacheMaxAge: 64800
      },
      'dist/dev': {  // Regex match
        cacheMaxAge: 2
      }
    },
    createdFileHeaders: {
      'dist/master/service-worker.js': { // Regex match
        'Service-Worker-Allowed': '/'
      }
    }
  }]
}).then(function (res) {
  console.log(res.length + 'files uploaded');
})

studioHelper.createDirectoryFolders(folderData) ⇒ Array.<ResultObj>

Create folders found in local directory if not already created

Kind: instance method of StudioHelper
Returns: Array.<ResultObj> - ResultObj.result

studioHelper.getLocalFolders(path) ⇒ Array.<string>

Get local directory folders

Kind: instance method of StudioHelper
Returns: Array.<string> - folders

studioHelper.getFiles(folderId) ⇒ Promise.<Array.<Object>>

Get files of a folder

Kind: instance method of StudioHelper

studioHelper.deleteFiles(files, options) ⇒ Promise.<Object>

Delete files

Kind: instance method of StudioHelper

studioHelper.uploadFiles(files, folderId) ⇒ Promise.<Array.<Object>>

Upload files to a specified folder

Kind: instance method of StudioHelper

studioHelper.replaceFiles(files, options) ⇒ Promise.<Array.<Object>>

Replace files

Kind: instance method of StudioHelper

studioHelper.getFileHeaders(fileId) ⇒ ResultObj

Get file headers

Kind: instance method of StudioHelper

studioHelper.setFileHeaders(fileId, headerSettings, options) ⇒ ResultObj

Update file headers

Kind: instance method of StudioHelper

studioHelper.getUploadInformation(files, folderId) ⇒ Array.<Object>

Get required information about files for upload

Kind: instance method of StudioHelper
Returns: Array.<Object> - Array of file information objects

studioHelper.getReplaceInformation(files, options)

Get required information about files for replacement

Kind: instance method of StudioHelper

studioHelper.getFolders(parentId) ⇒ Promise.<Object>

Get folders

Kind: instance method of StudioHelper

studioHelper.createFolder(settings) ⇒ ResultObj

Create folder

Kind: instance method of StudioHelper
Returns: ResultObj - ResultObj.result

studioHelper.deleteFolder(folderId) ⇒ Promise.<Object>

Delete folder

Kind: instance method of StudioHelper

studioHelper.deleteChildFolders(folderId) ⇒ Promise.<Object>

Delete child folders of a given folder

Kind: instance method of StudioHelper

studioHelper.getFolderSettings(folderId) ⇒ ResultObj

Get folder settings

Kind: instance method of StudioHelper
Returns: ResultObj - ResultObj.result

studioHelper.updateFolderSettings(folderId, folderSettings, options) ⇒ ResultObj

Update folder settings

Kind: instance method of StudioHelper

studioHelper.batchUpload(files) ⇒ Array.<object>

Batch upload/replace files

Kind: instance method of StudioHelper
Returns: Array.<object> - result

ApiResponse : Object

Kind: global typedef
Properties

ResultObj : Object

Kind: global typedef
Properties

ProgressOptions

Kind: global typedef

Properties

FileHeaderSettings : Object

Key / value pairs of wanted header names and their values

Kind: global typedef

CreateFolderResult : Object

Kind: global typedef
Properties

FolderSettings : Object

Kind: global typedef
Properties

FolderUpdateSettings : Object

Kind: global typedef
Properties