repzo 1.0.0 → 1.0.3

package/changelog.md

@@ -0,0 +1,13 @@
+# Release Notes
+
+## [v1.0.0 (2022-03-14)](https://github.com/Repzo/repzo-ts.git)
+
+### Added
+
+### Changed
+
+### Fixed
+
+### Removed
+
+## [unreleased (date)](path)

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "repzo",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "Repzo TypeScript SDK",
-  "main": "index.js",
+  "main": "./lib/index.js",
   "scripts": {
-    "test": "npm run test"
+    "test": "npm run test",
+    "build": "tsc"
   },
   "repository": {
     "type": "git",
@@ -18,5 +19,8 @@
   "bugs": {
     "url": "https://github.com/Repzo/repzo-ts/issues"
   },
-  "homepage": "https://github.com/Repzo/repzo-ts#readme"
+  "homepage": "https://github.com/Repzo/repzo-ts#readme",
+  "dependencies": {
+    "axios": "^0.26.1"
+  }
 }

package/src/index.ts

@@ -0,0 +1,120 @@
+import axios from "axios";
+import { Params, Data, Service, Options, Headers } from "./types/index";
+
+export default class Repzo {
+  private svAPIEndpoint: string;
+  headers: Headers;
+  constructor(apiKey: string, options?: Options) {
+    this.svAPIEndpoint =
+      !options?.env || options?.env == "production"
+        ? "https://sv.api.repzo.me"
+        : options?.env == "staging"
+        ? "https://staging.sv.api.repzo.me"
+        : options?.env == "local"
+        ? "http://localhost:3030"
+        : "";
+
+    this.headers = {
+      "api-key": apiKey,
+      "Content-Type": "application/json",
+      Accept: "application/json"
+    };
+    if (options?.headers) Object.assign(this.headers, options.headers);
+  }
+
+  private async _fetch(baseUrl: string, path: string, params?: Params) {
+    let res = await axios.get(baseUrl + path, {
+      params,
+      headers: this.headers
+    });
+    return res.data;
+  }
+
+  private async _create(
+    baseUrl: string,
+    path: string,
+    body: Data,
+    params?: Params
+  ) {
+    let res = await axios.post(baseUrl + path, body, {
+      params,
+      headers: this.headers
+    });
+    return res.data;
+  }
+
+  private async _update(
+    baseUrl: string,
+    path: string,
+    body: Data,
+    params?: Params
+  ) {
+    let res = await axios.put(baseUrl + path, body, {
+      params,
+      headers: this.headers
+    });
+    return res.data;
+  }
+
+  private async _delete(baseUrl: string, path: string, params?: Params) {
+    let res = await axios.delete(baseUrl + path, {
+      params,
+      headers: this.headers
+    });
+    return res.data;
+  }
+
+  client = {
+    _path: "/client",
+    find: async (
+      params?: Service.Client.Find.Params
+    ): Promise<Service.Client.Find.Result> => {
+      let res: Service.Client.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.client._path,
+        params
+      );
+      return res;
+    },
+
+    get: async (
+      id: Service.Client.Get.ID,
+      params?: Service.Client.Get.Params
+    ): Promise<Service.Client.Get.Result> => {
+      return await this._fetch(
+        this.svAPIEndpoint,
+        this.client._path + `/${id}`,
+        params
+      );
+    },
+
+    create: async (
+      body: Service.Client.Create.Body
+    ): Promise<Service.Client.Create.Result> => {
+      let res = await this._create(this.svAPIEndpoint, this.client._path, body);
+      return res;
+    },
+
+    update: async (
+      id: Service.Client.Update.ID,
+      body: Service.Client.Update.Body
+    ): Promise<Service.Client.Update.Result> => {
+      let res: Service.Client.Update.Result = await this._update(
+        this.svAPIEndpoint,
+        this.client._path + `/${id}`,
+        body
+      );
+      return res;
+    },
+
+    remove: async (
+      id: Service.Client.Remove.ID
+    ): Promise<Service.Client.Remove.Result> => {
+      let res: Service.Client.Remove.Result = await this._delete(
+        this.svAPIEndpoint,
+        this.client._path + `/${id}`
+      );
+      return res;
+    }
+  };
+}

package/src/types/index.ts

@@ -0,0 +1,276 @@
+export interface Params {
+  [key: string]: any;
+}
+
+export interface Data {
+  [key: string]: any;
+}
+export interface Options {
+  env?: "staging" | "local" | "production";
+  headers?: { [key: string]: string };
+}
+export interface Headers {
+  "api-key": string;
+  "Content-Type": string;
+  Accept: string;
+  [key: string]: string;
+}
+// <reference path = "vehicle.ts" />
+export namespace Service {
+  export namespace Client {
+    interface Financials {
+      credit_limit?: number;
+    }
+    type JobType = 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    interface JobObject {
+      type: JobType[];
+      description: string;
+      tag: string;
+      product_id?: string;
+      form_id?: string;
+      is_required?: boolean;
+      category_id?: string;
+      order?: number;
+      company_namespace: string[];
+    }
+    interface ShelfshareTarget {
+      msl: string;
+      contracted_checkout: number;
+      contracted_shelf_length: number;
+      total_category_length: number;
+    }
+    interface RepTarget {
+      rep: string;
+      target: number;
+      classification: string;
+    }
+    interface ClientSchema {
+      _id: string;
+      local_name?: string;
+      tags?: string[];
+      cell_phone?: string;
+      city?: string;
+      client_code?: string;
+      contact_name?: string;
+      contact_title?: string;
+      country?: string;
+      disabled?: boolean;
+      formatted_address?: string;
+      lat?: number;
+      lng?: number;
+      location_verified?: boolean;
+      name: string;
+      phone?: string;
+      state?: string;
+      zip?: string;
+      assigned_to?: string[];
+      last_location_update?: number;
+      credit_limit?: number;
+      tax_number?: string;
+      sync_id?: string;
+      rep_targets?: RepTarget[];
+      shelf_share_targets?: ShelfshareTarget[];
+      profile_pic?: string;
+      logo?: string;
+      website?: string;
+      email?: string;
+      comment?: string;
+      parent_client_id?: string;
+      target_visit?: number;
+      geofencing_radius?: number;
+      price_tag?: string;
+      jobs?: JobObject[];
+      status?: string;
+      job_category?: string[];
+      availability_msl?: string[];
+      territory?: string;
+      sv_priceList?: string;
+      assigned_media?: string[];
+      assigned_products?: string[];
+      assigned_product_groups?: string;
+      verifiedUntil?: number;
+      financials?: Financials;
+      customFields?: { [key: string]: any };
+      paymentTerm?: string;
+      speciality?: string[];
+      company_namespace: string[];
+      channel?: string;
+      isChain?: boolean;
+      chain?: string;
+      teams?: string[];
+      payment_type: "cash" | "credit";
+      integration_meta?: { [key: string]: any };
+      integrated_client_balance?: number;
+      createdAt: string;
+      updatedAt: string;
+      __v: number;
+    }
+    interface ClientBody {
+      name?: string;
+      local_name?: string;
+      tags?: string[];
+      cell_phone?: string;
+      city?: string;
+      client_code?: string;
+      contact_name?: string;
+      contact_title?: string;
+      country?: string;
+      disabled?: boolean;
+      formatted_address?: string;
+      lat?: number;
+      lng?: number;
+      location_verified?: boolean;
+      phone?: string;
+      state?: string;
+      zip?: string;
+      assigned_to?: string[];
+      last_location_update?: number;
+      credit_limit?: number;
+      tax_number?: string;
+      sync_id?: string;
+      rep_targets?: RepTarget[];
+      shelf_share_targets?: ShelfshareTarget[];
+      profile_pic?: string;
+      logo?: string;
+      website?: string;
+      email?: string;
+      comment?: string;
+      parent_client_id?: string;
+      target_visit?: number;
+      geofencing_radius?: number;
+      price_tag?: string;
+      jobs?: JobObject[];
+      status?: string;
+      job_category?: string[];
+      availability_msl?: string[];
+      territory?: string;
+      sv_priceList?: string;
+      assigned_media?: string[];
+      assigned_products?: string[];
+      assigned_product_groups?: string;
+      verifiedUntil?: number;
+      financials?: Financials;
+      customFields?: { [key: string]: any };
+      paymentTerm?: string;
+      speciality?: string[];
+      company_namespace?: string[];
+      channel?: string;
+      isChain?: boolean;
+      chain?: string;
+      teams?: string[];
+      payment_type?: "cash" | "credit";
+      integration_meta?: { [key: string]: any };
+      integrated_client_balance?: number;
+    }
+    type PopulatedKeys =
+      | "tags"
+      | "reps"
+      | "assigned_to"
+      | "sv_priceList"
+      | "paymentTerm"
+      | "job_category"
+      | "msl"
+      | "chain"
+      | "channel"
+      | "status"
+      | "product"
+      | "assigned_products"
+      | "assigned_product_groups"
+      | "speciality"
+      | "teams";
+
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        from_updatedAt?: number;
+        to_updatedAt?: number;
+        from_createdAt?: number;
+        to_createdAt?: number;
+        createdAt?: number;
+        updatedAt?: number;
+        name?: string;
+        search?: string;
+        disabled?: boolean;
+        active?: boolean;
+        tags?: string[] | string;
+        _id?: string[] | string;
+        assigned_to?: string[] | string;
+        availability_msl?: string[] | string;
+        status?: string[] | string;
+        CLIENT_TAGS?: string[] | string;
+        AREA_TAGS?: string[] | string;
+        isChain?: boolean;
+        chain?: string[] | string;
+        channel?: string[] | string;
+        city?: string[] | string;
+        client_code?: string[] | string;
+        country?: string[] | string;
+        location_verified?: boolean;
+        state?: string[] | string;
+        sv_priceList?: string[] | string;
+        assigned_media?: string[] | string;
+        assigned_products?: string[] | string;
+        teams?: string[] | string;
+        integrated_client_balance?: number;
+        tax_number?: string;
+        speciality?: string[] | string;
+        assigned_product_groups?: string[] | string;
+        populatedKeys?: PopulatedKeys[];
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: ClientSchema[];
+      }
+    }
+
+    export namespace Get {
+      export type ID = string;
+      export interface Params {
+        populatedKeys: PopulatedKeys[];
+      }
+      export type Result = ClientSchema;
+    }
+
+    export namespace Create {
+      export interface Body extends ClientBody {
+        name: string;
+      }
+      export type Result = ClientSchema;
+    }
+
+    export namespace Update {
+      export type ID = string;
+      export interface Body extends ClientBody {
+        _id?: string;
+        createdAt?: string;
+        updatedAt?: string;
+        __v?: number;
+      }
+      export type Result = ClientSchema;
+    }
+
+    export namespace Remove {
+      export type ID = string;
+      export type Result = ClientSchema;
+    }
+  }
+}
+
+export interface DefaultPaginationQueryParams {
+  per_page?: number;
+  page?: number;
+  sort?: "name" | "client_code" | "createdAt" | "updatedAt";
+  sortPageOrder?: "asc" | "dsc";
+}
+
+export interface DefaultPaginationResult {
+  total_result: number;
+  current_count: number;
+  total_pages: number;
+  current_page: number;
+  per_page: number;
+  first_page_url: string;
+  last_page_url: string;
+  next_page_url: string | null;
+  prev_page_url: string | null;
+  path: string;
+  data: any[];
+}

package/test.ts

@@ -0,0 +1,8 @@
+import Repzo from "./src/index.js";
+let repzo = new Repzo("");
+let clients = repzo.client.find({ search: "Mecca" });
+console.log(clients);
+repzo.client.create({ name: "kf" });
+repzo.headers["ho"] = "faf";
+repzo.client.update("", {});
+// repzo.

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "outDir": "./lib",
+    "allowJs": true,
+    "target": "ES2020",
+    "module": "ES2020",
+    "esModuleInterop": true,
+    "moduleResolution": "Node",
+    "resolveJsonModule": true,
+    "noImplicitThis": false,
+    "strict": true,
+    "declaration": true,
+  },
+  "ts-node": { "esm": true },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "test/**/*", "**/*.spec.ts"]
+}