Global Functions

Templates ^ 1.1.0

Для избавления от рутинных действий при работе с API предусмотрены template-ы, задача которых - автоматическое переформатирование приходящих с API данных.

Пример исходных данных:

{
    "data": [
        {
            "id": 0,
            "title": "Some Article",
            "desc": "Test Description"
        }
    ],
    "meta": {
        "total_count": 56,
        "current_page": 2,
        "per_page": 3
    }
}

Единственная полезная часть ответа - содержимое data (к meta-данным также можно иметь доступ, об этом в Protocol).

Можно написать template функцией RegisterTemplate:

import {RegisterTemplate} from 'nuxoblivius'

RegisterTemplate('my-template', (raw: object) => {
    if(raw.data) 
        return {
            data: raw.data,
            pageCount: raw.meta?.total_count / raw.meta?.per_page ?? 1 // определяем количество страничек, чтобы знать, на каком моменте остановить пагинацию
        }
    else return raw
})

, а затем использовать его при определении Record-а:

import {Record} from 'nuxoblivius'

const articles = Record.new<IArticle>('/api/articles')
    .template('my-template')

await articles.get()

console.log(articles.response)
/**
 * [
 *    {
 *       "id": 0,
 *       "title": "Some Article",
 *       "desc": "Test Description"
 *    }
 *    ...
 * ]
 */

Также можно написать template-функцию и прямо в Record:

const articles = Record.new<IArticle>('/api/articles')
    .template((raw) => {
        return {
            data: raw.data,
            pageCount: raw.meta?.total_count / raw.meta?.per_page ?? 1
        }
    })

await articles.get()

Предоставляется возможность использовать template-функцию вне Record и Stor-а как такового - применимо к любому объекту - функцией CallPattern:

import {RegisterTemplate, CallPattern} from 'nuxoblivius'

RegisterTemplate(
    'unpack-template', 
    (raw: object) => ({ data: raw.data })
)

const myData = { 'data': [ { message: 'message_1' } ...] }

const { data: formatedData } = CallPattern('unpack-template', myData)
/**
 * [{ message: 'message_1' } ...]
 */

Функция CallPattern распаковывает данные из любого объекта согласно прописанному шаблону.

Можно использовать templat-ы и цепочками:

RegisterTemplate(
    'unpack-template', 
    (raw: object) => ({ data: raw.data })
)

RegisterTemplate(
    'format', 
    (unpackTemplate: object) => ({ 
        data: CallPattern('unpack-template', unpackTemplate).data.map(() => <some logic>) 
    })
)

const { data: formatedData } = CallPattern('format', myData)

RegisterTemplate('unpack-data-and-structing', (raw: IRawArticles) => {
    // Calling another template
    raw = CallPattern('unpack-data', raw)

    if(raw.data) {
        // Adding checking for existence of Description 
        raw.data = raw.data.map(
            (value) => ({
                ...value,
                hadDescription: value.desc ? true : false
            })
        )

        return raw
    }
})

// Articles.ts

import {defineStore, Record} from 'nuxoblivius'

class Articles {
    public articles = Record.new<IArticle>('/api/articles')
        .template('unpack-data-and-structing')
        // Also can do like that
        .template((raw: IRawArticle) => {
            return { data: raw.data }
        })
        ...
}

export default defineStore<Articles>(Articles)

Protocol

Можно дать доступ к дополнительной информации из ответа api, используя объект protocol внутри template и функцию defineProtocol из Record:

const articles = Record.new<IArticle>('/api/articles')
    ...
    .template((raw: object) => ({ 
        data: raw.data,
        protocol: {
            meta: raw.meta
            secondData: 'other data'
        } 
    }))
    // Define protocol for reading data from template
    .defineProtocol<IMetaResponse>('meta', {} /* Default Value */)
    .defineProtocol<IMetaResponse>('secondData', '' /* Default Value */)
    .defineProtocol<IMetaResponse>('thirdData', 'third' /* Default Value */)

await articles.get()

console.log(articles.protocol.meta)
/**
 * {
 *    current_page: 1,
 *    total: 20,
 *    perPage: 10
 * }
 */
console.log(articles.protocol.secondData)
/**
 * 'other data'
 */
console.log(articles.protocol.thirdData)
/**
 * 'third'
 */

Такие данные доступны не из объекта response, а из отдельного объекта protocol.

setDefaultHeader

Доступна функция setDefaultHeader, которая, как понятно из названия, добавляет по умолчанию определенный заголовок при каждом запросе к API каждого Record-а:

import { SetDefaultHeader } from 'nuxoblivius'

SetDefaultHeader('Content-Type', "application/json")

setDefaultAuth

Доступна функция setDefaultAuth, которая, аналогично предыдущей, добавляет по умолчанию заголовок Authorization с определенным значением при каждом запросе к API каждого Record-а:

import { SetDefaultHeader } from 'nuxoblivius'

SetDefaultAuth("Bearer |vmxzweqorekwfdsafmswqerqewrewhvhgl")

onRecordFetchFailed

Доступна функция onRecordFetchFailed, принимающая в аргументе функцию и выполняющая её при любом запросе к API, завершившемся ошибкой:

import { onRecordFetchFailed } from 'nuxoblivius'

onRecordFetchFailed(() => {console.log('Oops')})