mirror of
https://github.com/TandoorRecipes/recipes.git
synced 2026-01-02 04:39:54 -05:00
refactored Generic API
This commit is contained in:
smilerz
@@ -162,145 +162,120 @@ import axios from "axios";
|
||||
axios.defaults.xsrfCookieName = 'csrftoken'
|
||||
axios.defaults.xsrfHeaderName = "X-CSRFTOKEN"
|
||||
export const ApiMixin = {
|
||||
data() {
|
||||
return {
|
||||
api_settings: {
|
||||
// TODO consider moving this to an API type dictionary that contains api types with details on the function call name, suffix, etc
|
||||
'suffix': { // if OpenApiGenerator adds a suffix to model name in function calls
|
||||
'list': 's'
|
||||
},
|
||||
// model specific settings, when not provided will use defaults instead
|
||||
'food': { // must be lowercase
|
||||
// *REQUIRED* name is name of the model used for translations and looking up APIFactory
|
||||
'name': 'Food',
|
||||
// *OPTIONAL: parameters will be built model -> model_type -> default
|
||||
'model_type': 'tree',
|
||||
// *OPTIONAL* model specific params for api, if not present will attempt modeltype_create then default_create
|
||||
// an array will create a dict of name:value pairs
|
||||
'create': [['name', 'description', 'recipe', 'ignore_shopping', 'supermarket_category']], // required: unordered array of fields that can be set during create
|
||||
// *OPTIONAL* model specific params for api, includes ordered list of parameters
|
||||
// and an unordered array that will be converted to a dictionary and passed as the 2nd param
|
||||
'partialUpdate': ['id', // required: ordered array of list params to patch existing object
|
||||
['name', 'description', 'recipe', 'ignore_shopping', 'supermarket_category'] // must include ordered array of field names that can be updated
|
||||
],
|
||||
// *OPTIONAL* provide model specific typing
|
||||
// 'typing': {},
|
||||
},
|
||||
'keyword': {},
|
||||
'unit': {},
|
||||
'recipe': {
|
||||
'name': 'Recipe',
|
||||
'list': ['query', 'keywords', 'foods', 'books', 'keywordsOr', 'foodsOr', 'booksOr', 'internal', 'random', '_new', 'page', 'pageSize', 'options'],
|
||||
'typing': {
|
||||
'list': {
|
||||
'foods': 'string',
|
||||
'keywords': 'string',
|
||||
'books': 'string',
|
||||
}
|
||||
},
|
||||
methods: {
|
||||
/**
|
||||
* constructs OpenAPI Generator function using named parameters
|
||||
* @param {string} model string to define which model API to use
|
||||
* @param {string} api string to define which of the API functions to use
|
||||
* @param {object} options dictionary to define all of the parameters necessary to use API
|
||||
*/
|
||||
genericAPI: function(model, action, options) {
|
||||
let setup = getConfig(model, action)
|
||||
let func = setup.function
|
||||
let config = setup?.config ?? {}
|
||||
let params = setup?.params ?? []
|
||||
console.log('config', config, 'params', params)
|
||||
let parameters = []
|
||||
|
||||
},
|
||||
// collection of default attributes for model_type TREE. All settings except typing and values will be overwritten by model values
|
||||
'tree': {
|
||||
'values': {
|
||||
'root': 'getFunction()', // if default value is exactly 'getFunction()' will call getFunction(model_type, param, params)
|
||||
'tree': undefined,
|
||||
},
|
||||
'list': ['query', 'root', 'tree', 'page', 'pageSize'], // ordered array of list params for tree
|
||||
'typing': {
|
||||
'move': {
|
||||
'source': 'string',
|
||||
'target': 'string',
|
||||
}
|
||||
}
|
||||
},
|
||||
// collection of global defaults. All settings except typing and values will be overwritten by model_type or model values
|
||||
'default': {
|
||||
'list': ['query', 'page', 'pageSize'], // ordered array of list params for default listApi
|
||||
'destroy': ['id'], // ordered array of list params for default deleteApi
|
||||
'retrieve': ['id'], // ordered array of list params for default retrieveApi
|
||||
'merge': ['source', 'target'], // ordered array of list params for default mergeApi
|
||||
'move': ['source', 'target'], // ordered array of list params for default moveApi
|
||||
'create': [], // ordered array of list params for default createApi
|
||||
'partialUpdate': [], // ordered array of list params for default updateApi
|
||||
'values': {
|
||||
'query': undefined, // default values for list API
|
||||
'page': 1,
|
||||
'pageSize': 25,
|
||||
},
|
||||
'typing': { // optional settings to force type on parameters
|
||||
'merge': {
|
||||
'source': 'string',
|
||||
'target': 'string',
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
methods: {
|
||||
/**
|
||||
* constructs OpenAPI Generator function using named parameters
|
||||
* @param {string} model string to define which model API to use
|
||||
* @param {string} api string to define which of the API functions to use
|
||||
* @param {object} options dictionary to define all of the parameters necessary to use API
|
||||
*/
|
||||
genericAPI: function(model, api, options) {
|
||||
model = model.toLowerCase()
|
||||
// construct settings for this model and this api - values are assigned in order (default is overwritten by api overwritten by model)
|
||||
let settings = {...this.api_settings?.default ?? {}, ...this.api_settings?.[this.api_settings?.[model]?.model_type] ?? {}, ...this.api_settings[model]};
|
||||
// values and typing are also dicts and need to be merged,
|
||||
settings.values = {...this.api_settings?.default?.values ?? {},
|
||||
...this.api_settings?.[this.api_settings?.[model]?.model_type]?.values ?? {},
|
||||
...this.api_settings[model].values}
|
||||
settings.typing = {...this.api_settings?.default?.typing?.[api] ?? {},
|
||||
...this.api_settings?.[this.api_settings?.[model]?.model_type]?.typing?.[api] ?? {},
|
||||
...this.api_settings[model].typing?.[api]}
|
||||
let func = api + settings.name + (this.api_settings.suffix?.[api] ?? '')
|
||||
// does model params exist?
|
||||
let params = []
|
||||
let this_value = undefined
|
||||
settings[api].forEach(function (item, index) {
|
||||
|
||||
if (Array.isArray(item)) {
|
||||
this_value = {}
|
||||
for (const [k, v] of Object.entries(options)) { // filters options dict based on valus in array, I'm sure there's a better way to do this
|
||||
if (item.includes(k)) {
|
||||
this_value[k] = v
|
||||
let this_value = undefined
|
||||
params.forEach(function (item, index) {
|
||||
if (Array.isArray(item)) {
|
||||
this_value = {}
|
||||
// if the value is an array, convert it to a dictionary of key:value
|
||||
// filtered based on OPTIONS passed
|
||||
// maybe map/reduce is better?
|
||||
for (const [k, v] of Object.entries(options)) {
|
||||
if (item.includes(k)) {
|
||||
this_value[k] = formatParam(config?.[k], v)
|
||||
}
|
||||
}
|
||||
} else {
|
||||
this_value = options?.[item] ?? undefined
|
||||
if (this_value) {this_value = formatParam(config?.[item], this_value)}
|
||||
}
|
||||
} else {
|
||||
this_value = options?.[item] ?? settings.values?.[item] ?? undefined // set the value or apply default
|
||||
}
|
||||
if (this_value ==='getFunction()') {
|
||||
this_value = getFunction(item, settings?.model_type, options)
|
||||
}
|
||||
if (Object.keys(settings?.typing).includes(item)) {
|
||||
switch (settings.typing[item]) {
|
||||
case 'string':
|
||||
if (this_value) {this_value = String(this_value)}
|
||||
break;
|
||||
// if no value is found so far, get the default if it exists
|
||||
if (!this_value) {
|
||||
this_value = getDefault(config?.[item], options)
|
||||
}
|
||||
}
|
||||
params.push(this_value)
|
||||
});
|
||||
|
||||
let apiClient = new ApiApiFactory()
|
||||
return apiClient[func](...params)
|
||||
parameters.push(this_value)
|
||||
});
|
||||
|
||||
console.log(func, 'parameters', parameters, 'passed options', options)
|
||||
let apiClient = new ApiApiFactory()
|
||||
return apiClient[func](...parameters)
|
||||
},
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Utility functions to calculate default value
|
||||
* */
|
||||
export function getFunction(item, model_type, params) {
|
||||
if (item==='root' && model_type==='tree') {
|
||||
if ((!params?.query ?? undefined) || params?.query?.length == 0) {
|
||||
return 0
|
||||
// /*
|
||||
// * local functions for ApiMixin
|
||||
// * */
|
||||
function formatParam(config, value) {
|
||||
if (config) {
|
||||
for (const [k, v] of Object.entries(config)) {
|
||||
switch(k) {
|
||||
case 'type':
|
||||
switch(v) {
|
||||
case 'string':
|
||||
value = String(value)
|
||||
break;
|
||||
case 'integer':
|
||||
value = parseInt(value)
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
return value
|
||||
}
|
||||
function getDefault(config, options) {
|
||||
let value = undefined
|
||||
value = config?.default ?? undefined
|
||||
if (typeof(value) === 'object') {
|
||||
let condition = false
|
||||
switch(value.function) {
|
||||
// CONDITIONAL case requires 4 keys:
|
||||
// - check: which other OPTIONS key to check against
|
||||
// - operator: what type of operation to perform
|
||||
// - true: what value to assign when true
|
||||
// - false: what value to assign when false
|
||||
case 'CONDITIONAL':
|
||||
switch(value.operator) {
|
||||
case 'not_exist':
|
||||
condition = (
|
||||
(!options?.[value.check] ?? undefined)
|
||||
|| options?.[value.check]?.length == 0
|
||||
)
|
||||
if (condition) {
|
||||
value = value.true
|
||||
} else {
|
||||
value = value.false
|
||||
}
|
||||
break;
|
||||
}
|
||||
break;
|
||||
}
|
||||
return undefined
|
||||
}
|
||||
return value
|
||||
}
|
||||
|
||||
function getConfig(model, action) {
|
||||
let f = action.function
|
||||
// if not defined partialUpdate will use params from create
|
||||
if (f === 'partialUpdate' && !model?.[f]?.params) {
|
||||
model[f] = {'params': [...['id'], ...model.create.params]}
|
||||
}
|
||||
|
||||
let config = {
|
||||
'name': model.name,
|
||||
'function': f + model.name + action?.suffix
|
||||
}
|
||||
// spread operator merges dictionaries - last item in list takes precedence
|
||||
config = {...config, ...action, ...model.model_type?.[f], ...model?.[f]}
|
||||
// nested dictionaries are not merged - so merge again on any nested keys
|
||||
config.config = {...action?.config, ...model.model_type?.[f]?.config, ...model?.[f]?.config}
|
||||
config.function = config.function + config.name + (config?.suffix ?? '') // parens are required to force optional chaining to evaluate before concat
|
||||
return config
|
||||
}
|
||||
|
||||
|
||||
@@ -365,4 +340,5 @@ export const CardMixin = {
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user