@ikas/api-client 0.0.1-canary.7 → 1.0.1

package/src/api/base.ts

@@ -1,134 +0,0 @@
-import { ClientError, GraphQLClient } from 'graphql-request';
-import { GraphQLError } from 'graphql-request/dist/types';
-
-export type QueryOptions<T> = {
-  query: string;
-  variables?: T;
-  operationName?: string;
-};
-
-export type MutationOptions<T> = {
-  mutation: string;
-  variables?: T;
-  operationName?: string;
-};
-
-export type OnCheckTokenCallback<TokenData> = (tokenData?: TokenData) => Promise<{ accessToken: string | undefined; tokenData?: TokenData }>
-
-export type BaseGraphQLAPIClientOptions<TokenData> = {
-  accessToken: string;
-  graphApiUrl: string;
-  tokenData?: TokenData;
-  onCheckToken?: OnCheckTokenCallback<TokenData>;
-};
-
-export class BaseGraphQLAPIClient<TokenData> {
-  _client: GraphQLClient;
-  accessToken: string;
-  graphApiUrl: string;
-  tokenData?: TokenData;
-  onCheckToken?: OnCheckTokenCallback<TokenData>;
-
-  constructor({ accessToken, graphApiUrl, onCheckToken, tokenData }: BaseGraphQLAPIClientOptions<TokenData>) {
-    this.accessToken = accessToken;
-    this.graphApiUrl = graphApiUrl;
-    this._client = this.createGraphQLClient();
-    this.tokenData = tokenData;
-    this.onCheckToken = onCheckToken;
-  }
-
-  createGraphQLClient() {
-    const token = this.accessToken;
-
-    // Run GraphQL queries/mutations using a static function
-    // ... or create a GraphQL client instance to send requests
-    return new GraphQLClient(this.graphApiUrl, {
-      headers: {
-        'User-Agent': 'ikas-app-client',
-        ...(token ? { authorization: token ? `Bearer ${token}` : '' } : {}),
-      },
-      credentials: 'include',
-    });
-
-    // const authLink = setContext((_request, { headers }) => {
-    //   return {
-    //     headers: {
-    //       ...headers,
-    //       'User-Agent': 'ikas-app-client',
-    //       ...(token ? { authorization: token ? `Bearer ${token}` : '' } : {}),
-    //     },
-    //   };
-    // });
-    //
-    // const httpLink = createHttpLink({
-    //   credentials: 'include',
-    //   uri: this.graphApiUrl,
-    // });
-    //
-    // return new ApolloClient({
-    //   credentials: 'include',
-    //   link: authLink.concat(httpLink),
-    //   cache: new InMemoryCache(),
-    //   defaultOptions: {
-    //     watchQuery: {
-    //       fetchPolicy: 'no-cache',
-    //       errorPolicy: 'ignore',
-    //     },
-    //     query: {
-    //       fetchPolicy: 'no-cache',
-    //       errorPolicy: 'all',
-    //     },
-    //   },
-    // });
-  }
-
-  async query<TData = any, TVariables = any>(options: QueryOptions<TVariables>) {
-    return this._makeRequest<TData, TVariables>(options);
-  }
-
-  async mutate<TData = any, TVariables = any>(options: MutationOptions<TVariables>) {
-    return this._makeRequest<TData, TVariables>({
-      ...options,
-      query: options.mutation,
-    });
-  }
-
-  async _makeRequest<TData, TVariables>(options: QueryOptions<TVariables>) {
-    await this._checkToken();
-    try {
-      const data = await this._client.request<TData, TVariables>(options.query, options.variables);
-      return new APIResult<TData>({ data: options.operationName ? data[options.operationName] : data });
-    } catch (e) {
-      if (e instanceof ClientError) return new APIResult<TData>({ errors: e.response.errors });
-      else return new APIResult<TData>({ error: e.message });
-    }
-  }
-
-  async _checkToken() {
-    if (this.onCheckToken) {
-      const { accessToken, tokenData } = await this.onCheckToken(this.tokenData);
-      if (accessToken) {
-        this.accessToken = accessToken;
-        this.tokenData = tokenData;
-        this._client = this.createGraphQLClient();
-      }
-    }
-  }
-}
-
-export class APIResult<T> {
-  data?: T;
-  error?: string;
-  errors?: GraphQLError[];
-  partial?: boolean;
-
-  constructor(result: { data?: T; error?: string; errors?: GraphQLError[] }) {
-    this.data = result.data;
-    this.error = result.error;
-    this.errors = result.errors;
-  }
-
-  get isSuccess() {
-    return !this.errors?.length && !this.error;
-  }
-}

package/src/api/index.ts

@@ -1,2 +0,0 @@
-export * from './admin';
-export * from './oauth';

package/src/api/oauth/index.ts

@@ -1,47 +0,0 @@
-import axios from 'axios';
-import qs from 'qs';
-import { GetTokenWithAuthorizationCodeRequest, GrantTypeEnum, OAuthTokenResponse, RefreshTokenRequest } from './models';
-import { STORE_DOMAIN } from '../../globals';
-
-export * from './models';
-
-type CommonOptions = {
-  storeName: string;
-  [p: string]: string;
-};
-
-export class OAuthAPI {
-  static getOAuthUrl(options: CommonOptions) {
-    return `https://${options.storeName}${options.storeDomain || STORE_DOMAIN}/api/admin/oauth`;
-  }
-
-  static async getTokenWithAuthorizationCode(request: GetTokenWithAuthorizationCodeRequest, options: CommonOptions) {
-    return axios.post<OAuthTokenResponse | null>(
-      `${OAuthAPI.getOAuthUrl(options)}/token`,
-      qs.stringify({
-        ...request,
-        grant_type: GrantTypeEnum.AUTHORIZATION_CODE,
-      }),
-      {
-        headers: {
-          'Content-Type': 'application/x-www-form-urlencoded',
-        },
-      },
-    );
-  }
-
-  static async refreshToken(request: RefreshTokenRequest, options: CommonOptions) {
-    return axios.post<OAuthTokenResponse | null>(
-      `${OAuthAPI.getOAuthUrl(options)}/token`,
-      qs.stringify({
-        ...request,
-        grant_type: GrantTypeEnum.REFRESH_TOKEN,
-      }),
-      {
-        headers: {
-          'Content-Type': 'application/x-www-form-urlencoded',
-        },
-      },
-    );
-  }
-}

package/src/api/oauth/models.ts

@@ -1,37 +0,0 @@
-export enum GrantTypeEnum {
-  AUTHORIZATION_CODE = 'authorization_code',
-  CLIENT_CREDENTIALS = 'client_credentials',
-  REFRESH_TOKEN = 'refresh_token',
-}
-
-export enum APP_SCOPES {
-  READ_PRODUCTS = 'read_products',
-  WRITE_PRODUCTS = 'write_products',
-  READ_ORDERS = 'read_orders',
-  WRITE_ORDERS = 'write_orders',
-  READ_CUSTOMERS = 'read_customers',
-  WRITE_CUSTOMERS = 'write_customers',
-  READ_CAMPAIGNS = 'read_campaigns',
-  WRITE_CAMPAIGNS = 'write_campaigns',
-  READ_INVENTORIES = 'read_inventories',
-  WRITE_INVENTORIES = 'write_inventories',
-}
-
-export type GetTokenWithAuthorizationCodeRequest = {
-  client_id: string;
-  client_secret: string;
-  code: string;
-  redirect_uri: string;
-};
-export type RefreshTokenRequest = {
-  client_id: string;
-  client_secret: string;
-  refresh_token: string;
-};
-export type OAuthTokenResponse = {
-  token_type: string;
-  expires_in: number;
-  access_token: string;
-  scope: string;
-  refresh_token: string;
-};

package/src/globals/constants.ts

@@ -1,19 +0,0 @@
-type IkasConfigOptions = {
-  apiVersion?: string;
-  [p: string]: any | undefined; // experimental
-};
-
-export const STORE_DOMAIN = '.myikas.com';
-export const DEFAULT_API_VERSION = 'v1';
-
-export class IkasConfig {
-  storeDomain: string;
-  apiVersion: string;
-  adminApiUrl: string;
-
-  constructor(options: IkasConfigOptions) {
-    this.storeDomain = options.storeDomain || STORE_DOMAIN;
-    this.apiVersion = options.apiVersion || DEFAULT_API_VERSION;
-    this.adminApiUrl = `https://api${this.storeDomain}/api/${this.apiVersion}/admin/graphql`;
-  }
-}

package/src/globals/index.ts

@@ -1 +0,0 @@
-export * from './constants';

package/src/helpers/index.ts

@@ -1 +0,0 @@
-export * from './webhook-validate';

package/src/helpers/webhook-validate.ts

@@ -1,17 +0,0 @@
-import { IkasWebhook } from '../models';
-import crypto from 'crypto';
-
-export const webhookValidate = (clientSecret: string) => async (req: any, res: any, next: () => any) => {
-  const data: IkasWebhook = req.body;
-
-  const generatedHash = crypto
-    .createHmac('sha256', clientSecret || '')
-    .update(data.data, 'utf8')
-    .digest('hex');
-
-  if (generatedHash === data.signature) {
-    await next();
-  } else {
-    res.status(401).send({ message: 'invalid signature', statusCode: 401 });
-  }
-};

package/src/index.ts

@@ -1,34 +0,0 @@
-import { ikasAdminGraphQLAPIClient } from './api';
-import { IkasConfig } from './globals';
-import { OnCheckTokenCallback } from './api/base';
-
-export * from './api';
-export * from './globals';
-export * from './helpers';
-export * from './models';
-
-type AppProps<TokenData> = {
-  clientId: string;
-  clientSecret: string;
-  accessToken: string;
-  apiVersion?: 'v1';
-  tokenData?: TokenData;
-  onCheckToken?: OnCheckTokenCallback<TokenData>;
-  [p: string]: any; // experimental
-};
-
-export class ikas<TokenData> {
-  adminApi: ikasAdminGraphQLAPIClient<TokenData>;
-  config: IkasConfig;
-
-  constructor(props: AppProps<TokenData>) {
-    this.config = new IkasConfig(props);
-
-    this.adminApi = new ikasAdminGraphQLAPIClient({
-      accessToken: props.accessToken,
-      graphApiUrl: this.config.adminApiUrl,
-      tokenData: props.tokenData,
-      onCheckToken: props.onCheckToken,
-    });
-  }
-}

package/src/models/base.ts

@@ -1,7 +0,0 @@
-export interface IBaseModelWithIdAndDates {
-  id: string;
-  createdAt?: Date | null;
-  updatedAt?: Date | null;
-  merchantId?: string | null;
-  deleted?: boolean | null;
-}

package/src/models/index.ts

@@ -1 +0,0 @@
-export * from './webhook';

package/src/models/webhook/index.ts

@@ -1 +0,0 @@
-export * from './models';

package/src/models/webhook/models.ts

@@ -1,90 +0,0 @@
-import {
-  Category,
-  Customer,
-  MerchantAppPaymentStatusEnum,
-  MerchantAppPaymentTypeEnum,
-  MerchantAppSubscription,
-  MerchantLicenceStatusEnum,
-  Order,
-  Product,
-  ProductAttribute,
-  ProductAttributeOption,
-  ProductAttributeValue,
-  ProductBrand,
-  ProductStockLocation,
-  ProductTag,
-  ProductVariantType,
-  Variant,
-  VariantType,
-} from '../../api';
-
-export enum WebhookScope {
-  ORDER_CREATED = 'store/order/created',
-  ORDER_UPDATED = 'store/order/updated',
-  PRODUCT_CREATED = 'store/product/created',
-  PRODUCT_UPDATED = 'store/product/updated',
-  CUSTOMER_CREATED = 'store/customer/created',
-  CUSTOMER_UPDATED = 'store/customer/updated',
-  CUSTOMER_FAVORITE_PRODUCTS_CREATED = 'store/customerFavoriteProducts/created',
-  CUSTOMER_FAVORITE_PRODUCTS_UPDATED = 'store/customerFavoriteProducts/updated',
-  STOCK_CREATED = 'store/stock/created',
-  STOCK_UPDATED = 'store/stock/updated',
-  APP_DELETED = 'store/app/deleted',
-  APP_PAYMENT = 'store/app/payment',
-}
-
-export interface IkasWebhook {
-  id: string;
-  createdAt: string; // ISO String
-  scope: string;
-  merchantId: string;
-  data: string;
-  signature: string;
-  authorizedAppId: string;
-}
-
-interface IWebhookProductAttributeValue extends ProductAttributeValue {
-  productAttribute?: ProductAttribute | null;
-  productAttributeOption?: ProductAttributeOption | null;
-}
-
-interface IWebhookProductVariantType extends ProductVariantType {
-  variantType: VariantType;
-}
-
-interface IWebhookVariant extends Variant {
-  attributes?: IWebhookProductAttributeValue[] | null;
-}
-
-export interface IWebhookProduct extends Product {
-  productVariantTypes?: IWebhookProductVariantType[] | null;
-  variants: IWebhookVariant[];
-  attributes?: IWebhookProductAttributeValue[] | null;
-  tags?: ProductTag[] | null;
-  brand?: ProductBrand | null;
-  categories?: Category[] | null;
-}
-
-export interface IWebhookOrder extends Order {}
-export interface IWebhookCustomer extends Customer {}
-export interface IWebhookStock extends ProductStockLocation {}
-
-export type IWebhookStoreAppPaymentData = {
-  merchantAppPayment: {
-    _id: string;
-    appPaymentKey: string;
-    name: string;
-    type: MerchantAppPaymentTypeEnum;
-    status: MerchantAppPaymentStatusEnum;
-    paymentDate?: Date | null;
-    error?: string | null;
-  };
-  merchantLicence: {
-    licenceActivationDate?: Date | null;
-    fromDate?: Date | null;
-    toDate?: Date | null;
-    status: MerchantLicenceStatusEnum;
-    statusUpdatedAt: Date | null;
-    appSubscription?: MerchantAppSubscription[] | null;
-  };
-};

package/tsconfig.json

@@ -1,25 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": "./src",
-    "outDir": "./dist",
-    "module": "commonjs",
-    "target": "es5",
-    "sourceMap": true,
-    "declaration": true,
-    "forceConsistentCasingInFileNames": true,
-    "noImplicitReturns": true,
-    "noImplicitThis": true,
-    "strictNullChecks": true,
-    "suppressImplicitAnyIndexErrors": true,
-    "noUnusedLocals": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "resolveJsonModule": true
-  },
-  "exclude": [
-    "node_modules",
-    "dist"
-  ]
-}