@arrowsphere/api-client 2.7.0 → 2.8.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.8.0] - 2022-03-03
+
+### Added
+
+- Add endpoint graphQL
+
 ## [2.7.0] - 2022-03-03
 
 ### Added

package/build/abstractGraphQLClient.d.ts

@@ -0,0 +1,27 @@
+import { GraphQLClient } from 'graphql-request';
+import * as Dom from 'graphql-request/dist/types.dom';
+import { Options } from './abstractClient';
+import { GetProductsType } from './catalog';
+export declare type GraphQLResponseTypes = GetProductsType;
+export declare abstract class AbstractGraphQLClient {
+    /**
+     * Base path for HTTP calls
+     */
+    protected basePath: string;
+    /**
+     * Current path for HTTP calls
+     */
+    protected path: string;
+    protected client: GraphQLClient;
+    protected url: string;
+    protected token: string;
+    protected optionsHeader?: Dom.RequestInit['headers'];
+    protected options: Options;
+    private getClient;
+    setToken(apiKey: string): this;
+    setUrl(url: string): this;
+    setOptionsHeader(options: Dom.RequestInit['headers']): this;
+    setOptions(options: Options): this;
+    protected post(query: string): Promise<GraphQLResponseTypes>;
+    protected generateUrl(): string;
+}

package/build/abstractGraphQLClient.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractGraphQLClient = void 0;
+const graphql_request_1 = require("graphql-request");
+const url_1 = require("url");
+const path_1 = __importDefault(require("path"));
+class AbstractGraphQLClient {
+    constructor() {
+        /**
+         * Base path for HTTP calls
+         */
+        this.basePath = '';
+        /**
+         * Current path for HTTP calls
+         */
+        this.path = '';
+        this.url = '';
+        this.token = '';
+        this.options = {};
+    }
+    getClient() {
+        this.client = new graphql_request_1.GraphQLClient(this.generateUrl());
+        return this;
+    }
+    setToken(apiKey) {
+        this.token = apiKey;
+        return this;
+    }
+    setUrl(url) {
+        this.url = url;
+        return this;
+    }
+    setOptionsHeader(options) {
+        this.optionsHeader = options;
+        return this;
+    }
+    setOptions(options) {
+        this.options = options;
+        return this;
+    }
+    async post(query) {
+        this.getClient().client.setHeaders({
+            authorization: this.token,
+            ...this.optionsHeader,
+        });
+        return await this.client.request(query);
+    }
+    generateUrl() {
+        const url = new url_1.URL(`${this.options.isAdmin ? path_1.default.join('admin', this.basePath) : this.basePath}${this.path}`, this.url);
+        return url.toString();
+    }
+}
+exports.AbstractGraphQLClient = AbstractGraphQLClient;
+//# sourceMappingURL=abstractGraphQLClient.js.map

package/build/catalog/catalogGraphQLClient.d.ts

@@ -0,0 +1,17 @@
+import { AbstractGraphQLClient } from '../abstractGraphQLClient';
+import { GetProductsType } from './types/catalogGraphQLTypes';
+export declare class CatalogGraphQLClient extends AbstractGraphQLClient {
+    /**
+     * The base path of the Catalog API
+     */
+    private ROOT_PATH;
+    /**
+     * The base path of the API
+     */
+    protected basePath: string;
+    /**
+     * The Path of graphql catalog API
+     */
+    private GRAPHQL;
+    find(request: string): Promise<GetProductsType>;
+}

package/build/catalog/catalogGraphQLClient.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CatalogGraphQLClient = void 0;
+const abstractGraphQLClient_1 = require("../abstractGraphQLClient");
+// import { inspect } from 'util';
+class CatalogGraphQLClient extends abstractGraphQLClient_1.AbstractGraphQLClient {
+    constructor() {
+        super(...arguments);
+        /**
+         * The base path of the Catalog API
+         */
+        this.ROOT_PATH = 'catalog/';
+        /**
+         * The base path of the API
+         */
+        this.basePath = this.ROOT_PATH;
+        /**
+         * The Path of graphql catalog API
+         */
+        this.GRAPHQL = 'graphql';
+    }
+    async find(request) {
+        this.path = this.GRAPHQL;
+        return await this.post(request);
+    }
+}
+exports.CatalogGraphQLClient = CatalogGraphQLClient;
+//# sourceMappingURL=catalogGraphQLClient.js.map

package/build/catalog/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types/catalogGraphQLTypes';
+export * from './catalogGraphQLClient';

package/build/catalog/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types/catalogGraphQLTypes"), exports);
+__exportStar(require("./catalogGraphQLClient"), exports);
+//# sourceMappingURL=index.js.map

package/build/catalog/types/catalogGraphQLTypes.d.ts

@@ -0,0 +1,224 @@
+export declare type GetProductsType = {
+    getProducts?: PaginatedProductsType;
+};
+export declare type PaginatedProductsType = {
+    filters?: Array<FiltersType>;
+    pagination?: PaginationType;
+    products?: Array<ProductType>;
+    topOffers?: Array<ProductType>;
+};
+export declare type FiltersType = {
+    name?: string;
+    values?: FiltersValuesType;
+};
+export declare type FiltersValuesType = {
+    value?: string;
+    count?: number;
+};
+export declare type PaginationType = {
+    perPage?: number;
+    currentPage?: number;
+    totalPage?: number;
+    total?: number;
+    next?: string;
+    previous?: string;
+};
+export declare type ProductType = {
+    id?: string;
+    identifiers?: IdentifiersType;
+    name?: string;
+    classification?: string;
+    arrowCategories?: Array<string>;
+    arrowSubCategories?: Array<string>;
+    licenseAgreementType?: string;
+    family?: FamilyType;
+    isAddon?: boolean;
+    hasAddons?: boolean;
+    actionFlags?: ActionFlagsType;
+    addonPrimaries?: Array<IdentifiersType>;
+    conversionOfferPrimaries?: Array<IdentifiersType>;
+    baseOfferPrimaries?: Array<IdentifiersType>;
+    assets?: AssetsType;
+    environmentAvailability?: string;
+    marketplace?: string;
+    isEnabled?: boolean;
+    isTrial?: boolean;
+    isIndirectBusiness?: boolean;
+    lastUpdate?: string;
+    marketingText?: MarketingTextType;
+    vendorOfferUrl?: string;
+    serviceDescription?: string;
+    eula?: string;
+    endCustomerEula?: string;
+    endCustomerRequirements?: string;
+    endCustomerFeatures?: string;
+    xspUrl?: string;
+    saleConstraints?: SaleConstraintsType;
+    vendor?: VendorType;
+    program?: ProgramType;
+    weightTopSales?: number;
+    weightForced?: number;
+    priceBand?: Array<PriceBandType>;
+    defaultPriceBand?: PriceBandType;
+    relatedOffers?: Array<RelatedOfferType>;
+    resellers?: OfferResellersType;
+    scope?: string;
+};
+export declare type IdentifiersType = {
+    arrowsphere?: ArrowsphereIdentifierType;
+    vendor?: VendorIdentifierType;
+};
+export declare type ArrowsphereIdentifierType = {
+    sku?: string;
+    skuXsp?: string;
+    skuXac?: string;
+    orderableSku?: string;
+};
+export declare type VendorIdentifierType = {
+    name?: string;
+    family?: string;
+    offerName?: string;
+    sku?: string;
+    attributes?: AttributesType;
+};
+export declare type AttributesType = {
+    cancelSubscription?: boolean;
+    canSwitchAutoRenew?: boolean;
+    decreaseSeats?: boolean;
+    increaseSeats?: boolean;
+    partIdentifier?: string;
+    periodicity?: number;
+    planId?: string;
+    productId?: string;
+    productSku?: string;
+    reactivateSubscription?: boolean;
+    suspendSubscription?: boolean;
+    term?: number;
+    unitType?: string;
+};
+export declare type FamilyType = {
+    id?: string;
+    name?: string;
+};
+export declare type ActionFlagsType = {
+    isAutoRenew?: boolean;
+    isManualProvisioning?: boolean;
+    renewalSku?: string;
+};
+export declare type AssetsType = {
+    featurePictureUrl?: string;
+    mainLogoUrl?: string;
+    pictureUrl?: string;
+    squareLogoUrl?: string;
+};
+export declare type MarketingTextType = {
+    overviewDescription?: string;
+    featuresShort?: string;
+    featuresFull?: string;
+    features?: string;
+};
+export declare type SaleConstraintsType = {
+    customerQualifications?: Array<string>;
+    resellerQualifications?: Array<string>;
+    minQuantity?: number;
+    maxQuantity?: number;
+    maxSubscriptionConstraint?: string;
+    maxSubscriptionPerCustomer?: number;
+    saleGroup?: string;
+    requiredAttributes?: Array<string>;
+};
+export declare type VendorType = {
+    name?: string;
+};
+export declare type ProgramType = {
+    isEnabled?: boolean;
+    legacyCode?: string;
+    names?: ProgramNameType;
+};
+export declare type ProgramNameType = {
+    full?: string;
+};
+export declare type PriceBandType = {
+    actionFlags?: PriceBandActionFlagsType;
+    attributes?: Array<AttributeType>;
+    billing?: BillingType;
+    currency?: string;
+    dynamicAttributes?: DynamicAttributesType;
+    family?: FamilyType;
+    identifiers?: PriceBandIdentifiersType;
+    isEnabled?: boolean;
+    marketplace?: string;
+    name?: string;
+    orderingType?: string;
+    prices?: PricesType;
+    saleConstraints?: PriceBandSaleConstraintsType;
+    uom?: UomType;
+};
+export declare type PriceBandActionFlagsType = {
+    canBeCancelled?: boolean;
+    canBeReactivated?: boolean;
+    canBeSuspended?: boolean;
+    canDecreaseSeats?: boolean;
+    canIncreaseSeats?: boolean;
+};
+export declare type AttributeType = {
+    name?: string;
+    value?: string;
+};
+export declare type BillingType = {
+    cycle?: number;
+    term?: number;
+    type?: string;
+};
+export declare type DynamicAttributesType = {
+    diskSize?: string;
+    ram?: string;
+    region?: string;
+    vCpu?: string;
+    reservationsAutofitGroup?: string;
+    acu?: string;
+    marketSegment?: string;
+    version?: string;
+    metric?: string;
+};
+export declare type PriceBandIdentifiersType = {
+    arrowsphere?: PriceBandArrowsphereIdentifierType;
+    erp?: ErpIdentifierType;
+    vendor?: PriceBandVendorIdentifierType;
+};
+export declare type PriceBandArrowsphereIdentifierType = {
+    sku?: string;
+};
+export declare type ErpIdentifierType = {
+    sku?: string;
+};
+export declare type PriceBandVendorIdentifierType = {
+    purchasePlan?: string;
+    sku?: string;
+};
+export declare type PricesType = {
+    buy?: string;
+    sell?: string;
+    public?: string;
+};
+export declare type PriceBandSaleConstraintsType = {
+    availableDate?: string;
+    expiryDate?: string;
+    minQuantity?: number;
+    maxQuantity?: number;
+};
+export declare type UomType = {
+    quantity?: number;
+    type?: string;
+};
+export declare type RelatedOfferType = {
+    vendor?: string;
+    sku?: string;
+};
+export declare type OfferResellersType = {
+    owner?: ResellerType;
+    viewers?: Array<ResellerType>;
+};
+export declare type ResellerType = {
+    xspRef?: string;
+};

package/build/catalog/types/catalogGraphQLTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=catalogGraphQLTypes.js.map

package/build/index.d.ts

@@ -1,6 +1,9 @@
 export * from './publicApiClient';
+export * from './publicGraphQLClient';
 export * from './abstractEntity';
 export * from './abstractClient';
+export * from './abstractGraphQLClient';
+export * from './catalog/';
 export * from './licenses/';
 export * from './general/';
 export * from './subscriptions/';

package/build/index.js

@@ -11,8 +11,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./publicApiClient"), exports);
+__exportStar(require("./publicGraphQLClient"), exports);
 __exportStar(require("./abstractEntity"), exports);
 __exportStar(require("./abstractClient"), exports);
+__exportStar(require("./abstractGraphQLClient"), exports);
+__exportStar(require("./catalog/"), exports);
 __exportStar(require("./licenses/"), exports);
 __exportStar(require("./general/"), exports);
 __exportStar(require("./subscriptions/"), exports);

package/build/publicGraphQLClient.d.ts

@@ -0,0 +1,5 @@
+import { CatalogGraphQLClient } from './catalog/catalogGraphQLClient';
+import { AbstractGraphQLClient } from './abstractGraphQLClient';
+export declare class PublicGraphQLClient extends AbstractGraphQLClient {
+    getCatalogGraphQLClient(): CatalogGraphQLClient;
+}

package/build/publicGraphQLClient.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicGraphQLClient = void 0;
+const catalogGraphQLClient_1 = require("./catalog/catalogGraphQLClient");
+const abstractGraphQLClient_1 = require("./abstractGraphQLClient");
+class PublicGraphQLClient extends abstractGraphQLClient_1.AbstractGraphQLClient {
+    getCatalogGraphQLClient() {
+        return new catalogGraphQLClient_1.CatalogGraphQLClient().setUrl(this.url).setToken(this.token);
+    }
+}
+exports.PublicGraphQLClient = PublicGraphQLClient;
+//# sourceMappingURL=publicGraphQLClient.js.map

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
   },
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "Node.js client for ArrowSphere's public API",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -80,6 +80,8 @@
   "dependencies": {
     "@types/validatorjs": "3.15.0",
     "axios": "0.21.1",
+    "graphql": "^16.3.0",
+    "graphql-request": "^4.0.0",
     "validatorjs": "3.22.1"
   }
 }