A collection of models for interacting with the ATShop API. Easily create, read, update and delete ATShop resources.
NOTICE This is still very much a work in progress. The documentation for this package is mostly provided exclusively through TypeScript type hints.
There's a couple steps to getting started with atshop-service-models.
Just pull in the package through npm.
npm install atshop-service-modelsDepending on where you're implementing these models, you'll also need to pull in and setup a Feathers client.
npm install @feathersjs/feathers @feathersjs/socketio-client socket.io-clientTo set up atshop-service-models, you'll first need to get your API client up and running.
import Feathers from '@feathersjs/feathers';
import FeathersIO from '@feathersjs/socketio-client';
import SockeIO from 'socket.io-client';
const SocketClient = FeathersIO(SockeIO('https://api.atshop.io'));
const FeathersClient = Feathers();
FeathersClient.configure(SocketClient);import { ATShopServiceModels } from 'atshop-service-models';
FeathersClient.configure(ATShopServiceModels());Since we're using FeatherJS as our API intermediary, atshop-service-models can run in
either a browser or on your Node.js server. This can be very handy if you're deploying your own storefront and don't
want to depend on any backend other than ATShop.io.
import { ShopModel } from 'atshop-service-models';
// Fetch a shop by subdomain: (e.g. test-shop.atshop.io)
let Shop = await ShopModel.find({ domain: 'test-shop' }).fetchOne();
// Fetch a shop by custom domain: (e.g. example.com)
Shop = await ShopModel.find({ customDomain: 'example.com' });
// Fetch a shop by ID
Shop = await ShopModel.get('ZBAWZE4LzB4RoguGY');const products = await Shop.products.fetch(); // Returns an instance of PaginatedServiceModel.
products.data.forEach((product) => {
console.log(product.name); // Product name.
console.log(product.description); // Product description markdown.
console.log(product.minQuantity); // Minimum order quantity for the product.
console.log(product.stockCount); // Remaining stock.
console.log(product.value); // Dinero.js instance of the product price.
// https://sarahdayan.github.io/dinero.js/
});const categories = await Shop.categories.fetch();
categories.data.forEach((category) => {
console.log(category.title); // Category heading
console.log(category.slug); // Category slug
console.log(category.position); // Position of category relative to other categories.
});import { OrderModel } from 'atshop-service-models';
const order = await OrderModel.get('orderIdHere');
console.log(await order.product); // Product ordered.
console.log(await order.humanValue()); // Order value in a human format.
console.log(order.quantity); // Quantity of product ordered.
console.log(order.description); // Order description.All atshop-service-models models come equipped with a set of reusable methods and properties that are used to
interact with the API.
-
static AppGlobal Feathers.js application objectatshop-service-models -
static serviceFeathers.js service object for the current model. -
static create(data)Create a new resource for the current model. Returns an instance of self. -
static find(query)Build a query for the current model. Returns an instance ofPaginatedServiceModel. -
static get(_id)Fetch a single entry from the service by ID. -
patch(data)Merge the given data with the current model instance and send the changes to the API. -
delete()Delete the current model entry.
You can rather easily extend a model with your own functionality if you have any implementation specific needs.
import { OrderModel as OrderServiceModel } from 'atshop-service-models';
class OrderModel extends OrderServiceModel {
get emailer() {
return new MyEmailerService({ defaultEmail: this.email });
}
sendThankYouEmail() {
this.emailer.send({ message: 'Thank you for placing an order!' });
}
}
// Send email.
OrderModel.get('someOrderId').then((order) => order.sendThankYouEmail());To ensure your model is utilized for for future relationship calls. (e.g. ShopModel.products), you'll need to
register it during the configuration process.
FeathersClient.configure(ATShopServiceModels({
models: {
OrderModel, // Referencing the OrderModel you see up above.
}
}));Now, any relationship that returns an OrderModel (e.g. OrderFeedbackModel.order) will be an instance of your custom
OrderModel.
If you're a TypeScript user, you'll likely need to override the return types of model to model relationships.
class MyCustomProductModel extends ProductModel {
// "Belongs to" and "has one" relationships return a promise.
shop!: Promise<MyCustomShopModel> // Now you'll get proper type-hinting for any calls to the shop relationship on MyCustomProductModel.
}
class MyCustomShopModel extends ShopModel {
// "Has many" relationships return instances of PagiantedServiceModel.
products!: PaginatedServiceModel<MyCustomProductModel>
}If you're using the Feathers Socket.io client as described in
the above setup instructions, you'll be able to listen for changes made to ATShop resources. This isn't strictly a
feature of atshop-service-models as this functionality is provided directly by the Feathers
instance you passed atshop-service-models during setup.
All model instances are equipped with a static service getter that returns a Feathers Service
object specific to the model's associated service. This is where we derive the real-time functionality from in the
below example.
import { OrderModel } from 'atshop-service-models';
// Do note that you will receive events for all orders that are created for shops you have administrative permissions for.
OrderModel.service.on('created', async (orderData) => {
const order = new OrderModel(orderData);
const product = await order.product;
const stock = await product.stockForSale.count();
console.log(`An order was created by ${order.email}, you'll have ${stock - order.quantity} stock left after the order has been paid for.`)
})See the Feathers Events documentation for more information on this.
This repository is licensed under the ISC license.
Copyright (c) 2019, Jørgen Vatle.