Merge pull request #44 from FoxComm/api-types

added flow types for api data structures and flow-typed declarations …

Author: eugene-sy

flow-typed/api.js

@@ -0,0 +1,60 @@
+
+declare module '@foxcomm/api-js' {
+  declare type StringDict = {[name: string]: string};
+
+  declare type AbortablePromise = Promise & {
+    abort(): void;
+  };
+
+  declare type AgentLike = AbortablePromise & {
+    get(url: string): AgentLike;
+    post(url: string): AgentLike;
+    patch(url: string): AgentLike;
+    delete(url: string): AgentLike;
+
+    set(headers: StringDict): AgentLike;
+    withCredentials(): AgentLike;
+  };
+
+  declare type RequestOptions = {
+    headers?: StringDict,
+    credentials?: string,
+    agent?: AgentLike;
+  };
+
+  // @TODO: add subclasses
+  declare class ApiClass {
+    addresses: mixed;
+    auth: mixed;
+    creditCards: mixed;
+    storeCredits: mixed;
+    cart: mixed;
+    account: mixed;
+    orders: mixed;
+    reviews: mixed;
+    analytics: mixed;
+    crossSell: mixed;
+
+    addAuth(jwt: string): ApiClass;
+    removeAuth(): ApiClass;
+
+    // Returns customer id from parsed jwt string
+    // You can define jwt string via `addAuth` method, if there is no jwt strings method returns null.
+    getCustomerId(): ?number;
+
+    setHeaders(headers: StringDict): ApiClass;
+    addHeaders(headers: StringDict): ApiClass;
+    uri(path: string): string;
+    queryStringToObject(qs: string): StringDict;
+
+    request(method: string, uri: string, data: ?Object, options: ?RequestOptions): AbortablePromise;
+    get(uri: string, data: ?Object, options: ?Object): AbortablePromise;
+    post(uri: string, data: ?Object, options: ?Object): AbortablePromise;
+    patch(uri: string, data: ?Object, options: ?Object): AbortablePromise;
+    delete(uri: string, data: ?Object, options: ?Object): AbortablePromise;
+  }
+
+  declare function parseError(err: mixed): Array<string>;
+
+  declare module.exports: typeof ApiClass;
+}

types/api/album.js

@@ -0,0 +1,13 @@
+
+export type Image = {
+  alt: string,
+  src: string,
+  title?: string,
+};
+
+export type Album = {
+  id: number,
+  name: string,
+  images: Array<Image>,
+  archivedAt?: string,
+};

types/api/attrs.js

@@ -0,0 +1,13 @@
+
+export type Currency = {|
+  t: 'price',
+  v: {
+    currency: string,
+    value: number
+  }
+|};
+
+export type String = {|
+  t: 'string',
+  v: string
+|};

types/api/base.js

@@ -0,0 +1,8 @@
+
+export type Context = {|
+  name: string,
+  attributes: {
+    lang: string,
+    modality: string,
+  }
+|};

types/api/product.js

@@ -0,0 +1,31 @@
+
+import type { Context } from './base';
+import type { String } from './attrs';
+import type { Sku } from './sku';
+import type { Album } from './album';
+
+export type VariantValue = {
+  id: number,
+  name: string,
+  swatch: string,
+  skuCodes: Array<string>,
+};
+
+export type Variant = {
+  attributes: {
+    name: String,
+  },
+  values: Array<VariantValue>,
+};
+
+export type Product = {
+  id: number,
+  context: Context,
+  albums: Array<Album>,
+  skus: Array<Sku>,
+  attributes: {
+    name: String,
+    description: String,
+  },
+  variants: Array<Variant>,
+};

types/api/sku.js

@@ -0,0 +1,15 @@
+
+import type { Context } from './base';
+import type { Currency, String } from './attrs';
+import type { Album } from './album';
+
+export type Sku = {
+  id: number,
+  context: Context,
+  attributes: {
+    code: String,
+    salePrice: Currency,
+    retailPrice: Currency,
+  },
+  albums: Array<Album>,
+};

types/api/views/album.js

@@ -0,0 +1,12 @@
+
+export type Image = {
+  alt?: string,
+  src: string,
+  title?: string,
+  baseurl?: string,
+};
+
+export type Album = {
+  name: string,
+  images: Array<Image>,
+};

types/api/views/country.js

@@ -0,0 +1,13 @@
+
+export type Country = {
+  id: number,
+  name: string,
+  alpha2: string,
+  alpha3: string,
+  code: string,
+  continent: string,
+  currency: string,
+  uses_postal_code: boolean,
+  is_billable: boolean,
+  is_shippable: boolean,
+};

types/api/views/product.js

@@ -0,0 +1,21 @@
+
+import type { Album } from './album';
+import type { Taxonomy } from './taxonomy';
+
+export type Product = {
+  id: number,
+  productId: number,
+  slug: ?string,
+  context: string,
+  currency: string,
+  title: string,
+  description: ?string,
+  salePrice: string,
+  retailPrice: string,
+  currency: string,
+  albums: ?Array<Album> | Object,
+  skus: Array<string>,
+  tags?: Array<string>,
+  scope?: string,
+  taxonomies: Array<Taxonomy>,
+};

types/api/views/region.js

@@ -0,0 +1,7 @@
+
+export type Region = {
+  id: number,
+  name: string,
+  abbreviation: string,
+  countryId: number,
+};