lore-generate-new
Version:
Generates a new Lore application
155 lines (125 loc) • 5.21 kB
JavaScript
/**
* Configuration file for collections
*
* This file is where you define overrides for the default collection behaviors.
*/
export default {
default: {
/**
* The URL of the API server.
*
* If your API is behind server route like '/api', then make sure to include
* that in url in the apiRoot (e.g. 'https://www.example.com/api')
*/
// apiRoot: 'https://api.example.com',
/**
* Pluralization setting used by the framework when composing API endpoints.
*
* Model names in Lore are singular, but many APIs used a plural convention
* when making requests. Use this setting to tell the framework whether it
* should convert your model names to a plural form when making API calls.
*
* Here is an example of how this setting would affect the endpoints for
* a model named 'book':
*
* pluralize | endpoint
* ---------------------------
* true | /books
* false | /book
*/
// pluralize: true,
/**
* Casing style used by the framework when composing API endpoints.
*
* Since models are camelCased in Lore, the framework assumed the server uses
* camelCasing as well. For example, if you have a model called `bookAuthor`,
* and pluralization is turned off, `the framework will assume the endpoint is
* located at '/bookAuthor'. If the endpoint is something else, like '/book_author'
* you will need to tell the framework to modify its convention.
*
* casingStyle | endpoint
* ---------------------------
* snake | /book_author
* kebab | /book-author
* camel | /bookAuthor
* pascal | /BookAuthor
*/
// casingStyle: 'camel',
/**
* Headers that should be applied to all network requests.
*
* This function will be called before every network request, and any
* keys you provide will be added as a header in the network request.
*
* A common use would be sending an authorization token with each request:
*
* headers: function() {
* return {
* Authorization: 'JWT <token>'
* };
* }
*/
// headers: function() {
// return {};
// },
/****************************************************************************
* *
* Define properties that should apply to all models here. *
* You can override all of these methods on a per-model basis. *
* *
****************************************************************************/
models: {
properties: {
/**
* Use this function to control how the client id (cid) of each model
* is generated.
*
* By default all models have a cid that looks like 'c1', 'c2', etc.
* This cid is required to support optimistic updates against a REST API,
* and the format is intentionally concise in order to make it easy for
* developers to read and remember (mostly for debugging purposes).
*
* When your application integrates support for WebSockets though, this
* cid format is no longer sufficient, as supporting optimistic updates
* requires sending the cid to the API server, which requires it to be
* globally unique.
*
* This function exists so that you can modify the unique id and convert
* it to a UUID when required. A good library to do that can be found here:
* https://github.com/kelektiv/node-uuid
*/
// generateCid: function() {
// return _.uniqueId('c');
// },
/**
* Use this function to transform the server response before using it
* in the application (such as adding, removing or modifying properties)
*/
// parse: function(response) {
// return response;
// }
}
},
/****************************************************************************
* *
* Define properties that should apply to all collections here. *
* You can override all of these methods on a per-collection basis. *
* *
****************************************************************************/
collections: {
properties: {
/**
* Use this function to transform the server response before using it
* in the application (such as adding, removing or modifying properties)
*
* This method only gets called when making a request to a collection endpoint
* like '/books'. Once it completes, each resource in the response will
* automatically be processed by the parse method of the corresponding model.
*/
// parse: function(response) {
// return response;
// }
}
}
}
};