observation-js/dist/lib/media.js

A fully-typed TypeScript client for the waarneming.nl API.

export class Media {
    #client;
    /**
     * @internal
     */
    constructor(client) {
        this.#client = client;
    }
    /**
     * Uploads a media file (photo or sound) to get a temporary name.
     * This temporary name can then be used when creating or updating an observation.
     *
     * @param media The media file (as a Blob) to upload.
     * @param options - Optional parameters.
     * @param options.identify - If `true`, the system will attempt to identify the species in the media.
     * @returns A promise that resolves to the media upload response, containing the temporary name.
     * @throws {AuthenticationError} If the request is not authenticated.
     * @throws {ApiError} If the request fails.
     */
    async upload(media, options = {}) {
        const formData = new FormData();
        formData.append('media', media);
        const params = {};
        if (options.identify) {
            params.identify = 'true';
        }
        return this.#client.request('media-upload/', {
            method: 'POST',
            body: formData,
            params,
        });
    }
    /**
     * Fetches similar media items for a given media ID.
     * This endpoint can be used with or without authentication.
     *
     * @param id The unique identifier of the media item.
     * @returns A promise that resolves to a paginated list of similar media items.
     * @throws {ApiError} If the request fails.
     */
    async getSimilar(id) {
        const params = {
            model: 'Media',
            pk: id,
        };
        const request = this.#client.hasAccessToken()
            ? this.#client.request
            : this.#client.publicRequest;
        return request('media/similar/', {
            method: 'GET',
            params,
        });
    }
}