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

Constructors

Methods

  • Get cached credentials from file

    Returns null | Record<string, unknown>

  • Get all metadata fields defined in Stage for this Studio

    Returns Promise<GetMetadataFieldsResponse>

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

    Parameters

    Returns Promise<PushResponse>

    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');
    })
  • Update cached credentials.

    This is handled internally by the library, but can be called manually if needed.

    Parameters

    • data: Record<string, any>

    Returns boolean