Repositories

getRepos Operator user required Frontend can be closed, restricted or open

Get list of repositories

[
    {
        Name: "kara.moe",
        Online: true,
        Enabled: true,
        SendStats: true,
        BaseDir: "app/data",
        AutoMediaDownloads: true,
        MaintainerMode: true,
        Git: {
            URL:           // Git URL for the repository
            Username:      // Git username
            Password:      // Git password
            Author:        // Git identity
            Email:         // Git email
            ProjectID?:    // Gitlab project ID
        };
        FTP: {
            Port:          // FTP port
            Host:          // FTP Host to put medias into
            Username:      // FTP username
            Password:      // FTP Password
            BaseDir:       // Directory inside the FTP where to upload files
        },
        Path: {
            Medias: ["app/data/medias"]
        }
    },
    ...
]

{
    code: 500,
    message: {
        code: 'REPO_LIST_ERROR'
    }
}

addRepo Operator user required Frontend can be closed, restricted or open

Add a new repository

{
    Name: 'world.karaokes.moe',
    Online: true // Is it an online repository?
    Enabled: true
    SendStats: true
    Path: {
        Karas: string[]
        Lyrics: string[]
        Medias: string[]
        Tags: string[]
    }
}

{
    code: 200,
    message: {
        code: 'REPO_CREATED'
    }
}

{
    code: 500,
    message: {
        code: 'REPO_CREATE_ERROR'
    }
}

getRepo Operator user required Frontend can be closed, restricted or open

Get a single repository

{
    name: 'kara.moe'
}

{
        "Name": "kara.moe",
        "Online": true
        "Enabled": true
        "SendStats": true
        "Path": {
            "Karas": ["app/data/karaokes"]
            "Lyrics": ["app/data/lyrics"]
            "Tags": ["app/data/tags"]
            "Medias": ["app/data/medias"]
        }
},

{
    code: 500,
    message: {
        code: 'REPO_GET_ERROR'
    }
}

deleteRepo Operator user required Frontend can be closed, restricted or open

Remove a repository from Karaoke Mugen

{
    name: 'kara.moe'
}

{
    code: 200,
    message: {
        code: 'REPO_DELETED'
    }
}

{
    code: 500,
    message: {
        code: 'REPO_DELETE_ERROR'
    }
}

editRepo Operator user required Frontend can be closed, restricted or open

Edit a repository

{
  name: 'kara.moe'
  newRepo: {
      Name: 'new.kara.moe'
      <See repo object in getRepos>
  }
}

{
  code: 200,
  message: {
      code: 'REPO_EDITED'
  }
}

{
    code: 500,
    message: {
        code: 'REPO_EDIT_ERROR'
    }
}

{
    code: 404
}

getUnusedTags Operator user required Frontend can be closed, restricted or open

Get a list of all tags unused in a repository.

{
  name: 'kara.moe'
}

{
    code: 500,
    message: {
        code: 'REPO_GET_UNUSEDTAGS_ERROR'
    }
}

getUnusedMedias Operator user required Frontend can be closed, restricted or open

View all unused medias from a repository. Unused medias aren't used by any karaoke.

Since this takes time, this creates a new Task.

{
  name: 'kara.moe'
}

[
    "/path/to/unused media 1.mp4"
    "/path/to/unused media 2.mp4"
]

{
    code: 500,
    message: {
        code: 'REPO_GET_UNUSEDMEDIA_ERROR'
    }
}

consolidateRepository Operator user required Frontend can be closed, restricted or open

This moves all folders from a repository into the same base folder.

Example if you have a repository with:

• Medias: /path/to/videos
• Karaokes: /MyGit/karaokes
• Lyrics: /MyGit/lyrics
• Tags: /MyGit/tags

If you consolidate it to /MyGit/ the videos folder will be moved to /MyGit/

{
  name: 'kara.moe',
  path: '/MyGit/'
}

{
    code: 200,
    message: {
        code: 'REPO_CONSOLIDATING_IN_PROGRESS'
    }
}

compareLyricsBetweenRepos Operator user required Frontend can be closed, restricted or open

Get a report of lyrics that differ between two repositories. It is useful when you have two repositories with the same songs in them and wish to make sure lyrics you modified on the first repository are copied to the second one.

{
  repo1: 'kara.moe',
  repo2: 'world.karaokes.moe'
}

[
    {
        kara1: <See Kara object>,
        kara2: <See Kara object>
    },
    ...
]

{
    code: 500,
    message: {
        code: 'REPO_COMPARE_LYRICS_ERROR'
    }
}

copyLyricsBetweenRepos Operator user required Frontend can be closed, restricted or open

Copies lyrics from one repository to another.

You feed this command the exact same results you got from Compare lyrics between repositories

[
    {
        kara1: <See Kara object>,
        kara2: <See Kara object>
    },
    ...
]

{
    code: 500,
    message: {
        code: 'REPO_COPY_LYRICS_ERROR'
    }
}

deleteAllRepoMedias Operator user required Frontend can be closed, restricted or open

Delete all medias from a specific repository (to free up space)

{
    name: 'kara.moe'
}

{
    code: 200,
    message: {
        code: 'REPO_ALL_MEDIAS_DELETED'
    }
}

{
    code: 500,
    message: {
        code: 'REPO_DELETE_ALL_MEDIAS_ERROR'
    }
}

deleteAllRepoMedias Operator user required Frontend can be closed, restricted or open

Delete old (played more than one month ago) medias from a specific repository (to free up space)

{
    name: 'kara.moe'
}

{
    code: 200,
    message: {
        code: 'REPO_OLD_MEDIAS_DELETED'
    }
}

{
    code: 500,
    message: {
        code: 'REPO_DELETE_OLD_MEDIAS_ERROR'
    }
}

deleteMedias Operator user required Frontend can be closed, restricted or open

Remove medias by selecting specific songs

{
    kids: ['abc', 'def']    
}

{
    code: 200,
    message: {
        code: 'REPO_MEDIAS_DELETED'
    }
}

{
    code: 500,
    message: {
        code: 'REPO_DELETE_MEDIAS_ERROR'
    }
}

updateAllRepositories Operator user required Frontend can be closed, restricted or open

Launches an update of all enabled and online repositories

updateAllRepositories Operator user required Frontend can be closed, restricted or open

Updates a repository using Git (maintainer mode only)

{
    repoName: 'kara.moe'
}

{
    code: 500,
    message: {
        code: 'REPO_GIT_UPDATE_ERROR'
    }
}

stashRepo Operator user required Frontend can be closed, restricted or open

Stashes any modifications (via git) in a re pository

{
    repoName: 'kara.moe'
}

{
    code: 500,
    message: {
        code: 'REPO_GIT_STASH_ERROR'
    }
}

checkRepo Operator user required Frontend can be closed, restricted or open

Check repository status (clean or not clean).

Clean means no modifications are present adn the repository is updatable.

{
    code: 500,
    message: {
        code: 'REPO_GIT_CHECK_ERROR'
    }
}

listRepoStashes Operator user required Frontend can be closed, restricted or open

Returns a list of repo stashes so that you can choose to pop or drop them

{
    repoName: 'kara.moe'
}

{
    code: 500,
    message: {
        code: 'REPO_GIT_CHECK_ERROR'
    }
}

popStash Operator user required Frontend can be closed, restricted or open

Pops an existing stash into the repository working directory

{
    repoName: 'kara.moe',
    stashId: 2
}

{
    code: 500,
    message: {
        code: 'REPO_GIT_UNSTASH_ERROR'
    }
}

dropStash Operator user required Frontend can be closed, restricted or open

Removes a stash from the git repository without popping it.

{
    repoName: 'kara.moe',
    stashId: 2
}

{
    code: 500,
    message: {
        code: 'REPO_GIT_UNSTASH_ERROR'
    }
}

resetRepo Operator user required Frontend can be closed, restricted or open

Performs a `git reset --hard origin/master` on a repository to reset it to its initial state.

{
    repoName: 'kara.moe'    
}

{
    code: 500,
    message: {
        code: 'REPO_GIT_RESET_ERROR'
    }
}

getCommits Operator user required Frontend can be closed, restricted or open

Generates a list of commits depending on which files are present in the working directory. The generated list allows you to check which commits are going to be made, modify them (message for example), and then submit them to the `pushCommits` route (see below)

Note: this does not create the commits in the git index, but rather generates a list of files to include in each commit. The real action is done by the pushCommits route.

{
    repoName: 'kara.moe'    
}

{
    code: 500,
    message: {
        code: 'REPO_GIT_GET_COMMITS_ERROR'
    }
}

pushCommits Operator user required Frontend can be closed, restricted or open

Pushes media via FTP, creates the commits in git and then pushes them, in that order.

{
    commits: {
        commits: [
            {
                addedFiles: ['karaokes/JPN - blabla - OP - truc.kara.json', 'lyrics/JPN - blabla - OP - truc.ass'],
                modifiedFiles: [],
                deletedFiles: [],
                message: 'Add kara'
            }
        ],
        modifiedMedias: [
            {
                old: null,
                new: 'JPN - blabla - OP - truc.mp4',
                commit: 'Add kara'
            }        
        ]
    },
    repoName: 'kara.moe',
    ignoreFTP: false //Ignores FTP actions if any should be done.
}

{
    code: 500,
    message: {
        code: 'REPO_GIT_PUSH_ERROR'
    }
}

uploadMedia Operator user required Frontend can be closed, restricted or open

Forces the upload of a song's particular media to the FTP

{
    kid: 'abcdefghj'
}

{
    code: 500,
    message: {
        code: 'REPO_UPLOAD_MEDIA_ERROR'
    }
}

syncTagsBetweenRepos Operator user required Frontend can be closed, restricted or open

Forces tags in `repoDestName` to be updated with their counterparts in `repoSourceName`

{
    repoSourceName: kara.moe,
    repoDestName: Local
}

{
    code: 500,
    message: {
        code: 'REPO_SYNC_TAGS_ERROR'
    }
}