@athoscommerce/snap-client 1.0.0

package/dist/esm/types.d.ts

@@ -0,0 +1,212 @@
+import { AppMode } from '@athoscommerce/snap-toolbox';
+import type { MetaRequestModel, SearchResponseModelResult, SearchRequestModel, MetaResponseModel } from '@athoscommerce/snapi-types';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type SearchRequesterPaths = {
+    autocomplete?: string;
+    search?: string;
+    category?: string;
+    finder?: string;
+};
+export type MetaRequesterPaths = {
+    meta?: string;
+};
+export type SuggestRequesterPaths = {
+    suggest?: string;
+    trending?: string;
+};
+export type RecommendRequesterPaths = {
+    recommend?: string;
+    profile?: string;
+};
+type RequesterConfig<RequestType, PathConfigurationType> = {
+    origin?: string;
+    headers?: HTTPHeaders;
+    cache?: CacheConfig;
+    globals?: Partial<RequestType>;
+    paths?: Partial<PathConfigurationType>;
+};
+export type ClientConfig = {
+    mode?: keyof typeof AppMode | AppMode;
+    initiator?: string;
+    fetchApi?: WindowOrWorkerGlobalScope['fetch'];
+    meta?: RequesterConfig<MetaRequestModel, MetaRequesterPaths>;
+    search?: RequesterConfig<SearchRequestModel, SearchRequesterPaths>;
+    recommend?: RequesterConfig<RecommendRequestModel, RecommendRequesterPaths>;
+    suggest?: RequesterConfig<SuggestRequestModel, SuggestRequesterPaths>;
+};
+export type CacheConfig = Partial<DefaultCacheConfig>;
+export type DefaultCacheConfig = {
+    enabled: boolean;
+    ttl: number;
+    maxSize: number;
+    purgeable: boolean;
+    entries?: {
+        [key: string]: Response;
+    };
+};
+export type CacheEntry = {
+    value: Response;
+    expires: number;
+    purgeable?: boolean;
+};
+export type Cache = {
+    [key: string]: CacheEntry;
+};
+export type GenericGlobals = {
+    [configurationPath: string]: any;
+};
+export type ClientGlobals = GenericGlobals & {
+    siteId: string;
+};
+export type SuggestRequestModel = {
+    siteId: string;
+    query: string;
+    language?: string;
+    suggestionCount?: number;
+    productCount?: number;
+    disableSpellCorrect?: boolean;
+};
+export type SuggestResponseModelSuggestion = {
+    text: string;
+    type?: string;
+    source?: string;
+    popularity?: number;
+    completed?: {
+        token: string;
+        query: string;
+        type: string;
+    }[];
+};
+export type SuggestResponseModel = {
+    query: string;
+    'corrected-query'?: string;
+    suggested?: SuggestResponseModelSuggestion;
+    alternatives?: SuggestResponseModelSuggestion[];
+};
+export type TrendingRequestModel = {
+    siteId: string;
+    limit?: number;
+};
+export type TrendingResponseModel = {
+    trending: {
+        queries: {
+            popularity: number;
+            searchQuery: string;
+        }[];
+    };
+};
+export type RecommendRequestModel = RecommendRequestGlobalsModel & RecommendRequestOptionsModel & {
+    tag: string;
+    profile?: RecommendRequestOptionsModel;
+};
+export type RecommendRequestGlobalsModel = {
+    product?: string;
+    products?: string[];
+    cart?: string[];
+    lastViewed?: string[];
+    shopper?: string;
+    filters?: RecommendationRequestFilterModel[];
+    blockedItems?: string[];
+    batchId?: number;
+    test?: boolean;
+};
+export type RecommendRequestOptionsModel = {
+    siteId?: string;
+    categories?: string[];
+    brands?: string[];
+    branch?: string;
+    filters?: RecommendationRequestFilterModel[];
+    blockedItems?: string[];
+    batched?: boolean;
+    limit?: number;
+    order?: number;
+    query?: string;
+    dedupe?: boolean;
+};
+export type RecommendPostRequestModel = {
+    siteId: string;
+    profiles: RecommendPostRequestProfileModel[];
+    product?: string;
+    products?: string[];
+    shopper?: string;
+    cart?: string[];
+    lastViewed?: string[];
+    test?: boolean;
+    withRecInfo?: boolean;
+    blockedItems?: string[];
+    filters?: RecommendPostRequestFiltersModel[];
+};
+export type RecommendPostRequestProfileModel = {
+    tag: string;
+    categories?: string[];
+    brands?: string[];
+    blockedItems?: string[];
+    limit?: number;
+    dedupe?: boolean;
+    searchTerm?: string;
+    filters?: RecommendPostRequestFiltersModel[];
+};
+export type RecommendPostRequestFiltersModel = {
+    field: string;
+    type: '=' | '==' | '===' | '!=' | '!==' | '>' | '<' | '>=' | '<=';
+    values: (string | number)[];
+};
+export type RecommendResponseModel = {
+    profile: {
+        tag: string;
+    };
+    results: SearchResponseModelResult[];
+    responseId: string;
+};
+export type ProfileRequestModel = {
+    siteId: string;
+    tag: string;
+    branch?: string;
+};
+export type ProfileResponseModel = {
+    profile: {
+        tag: string;
+        placement: string;
+        display: {
+            threshold: number;
+            template: {
+                name: string;
+                uuid: string;
+                markup?: string;
+                styles?: string;
+                component?: string;
+                branch?: string;
+                group?: string;
+                type?: string;
+            };
+            templateParameters: {
+                [any: string]: unknown;
+            };
+        };
+    };
+};
+export type RecommendationRequestFilterModel = RecommendationRequestRangeFilterModel | RecommendationRequestValueFilterModel;
+type RecommendationRequestRangeFilterModel = {
+    type: 'range';
+    field: string;
+    value: {
+        low?: number;
+        high?: number;
+    };
+};
+type RecommendationRequestValueFilterModel = {
+    type: 'value';
+    field: string;
+    value: string | number;
+};
+export type RecommendCombinedResponseModel = ProfileResponseModel & {
+    results: SearchResponseModelResult[];
+} & {
+    meta: MetaResponseModel;
+} & {
+    responseId: string;
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAErI,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAEpD,MAAM,MAAM,oBAAoB,GAAG;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,eAAe,CAAC,WAAW,EAAE,qBAAqB,IAAI;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAC1B,IAAI,CAAC,EAAE,MAAM,OAAO,OAAO,GAAG,OAAO,CAAC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAC9C,IAAI,CAAC,EAAE,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;IAC7D,MAAM,CAAC,EAAE,eAAe,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;IACnE,SAAS,CAAC,EAAE,eAAe,CAAC,qBAAqB,EAAE,uBAAuB,CAAC,CAAC;IAC5E,OAAO,CAAC,EAAE,eAAe,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,CAAC;CACtE,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAEtD,MAAM,MAAM,kBAAkB,GAAG;IAChC,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;KAAE,CAAC;CACtC,CAAC;AACF,MAAM,MAAM,UAAU,GAAG;IACxB,KAAK,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC5B,CAAC,iBAAiB,EAAE,MAAM,GAAG,GAAG,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG;IAC5C,MAAM,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE;QACX,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;KACb,EAAE,CAAC;CACJ,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,8BAA8B,CAAC;IAC3C,YAAY,CAAC,EAAE,8BAA8B,EAAE,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IACnC,QAAQ,EAAE;QACT,OAAO,EAAE;YACR,UAAU,EAAE,MAAM,CAAC;YACnB,WAAW,EAAE,MAAM,CAAC;SACpB,EAAE,CAAC;KACJ,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,4BAA4B,GAC/D,4BAA4B,GAAG;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,4BAA4B,CAAC;CACvC,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,gCAAgC,EAAE,CAAC;IAC7C,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,gCAAgC,EAAE,CAAC;IAC7C,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAGF,MAAM,MAAM,yBAAyB,GAAG;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,gCAAgC,EAAE,CAAC;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,OAAO,CAAC,EAAE,gCAAgC,EAAE,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,gCAAgC,EAAE,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,GAAG,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;IAClE,MAAM,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACpC,OAAO,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;IACF,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACrC,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAClC,OAAO,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE;YACR,SAAS,EAAE,MAAM,CAAC;YAClB,QAAQ,EAAE;gBACT,IAAI,EAAE,MAAM,CAAC;gBACb,IAAI,EAAE,MAAM,CAAC;gBACb,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,SAAS,CAAC,EAAE,MAAM,CAAC;gBACnB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,KAAK,CAAC,EAAE,MAAM,CAAC;gBACf,IAAI,CAAC,EAAE,MAAM,CAAC;aACd,CAAC;YACF,kBAAkB,EAAE;gBACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;aACvB,CAAC;SACF,CAAC;KACF,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG,qCAAqC,GAAG,qCAAqC,CAAC;AAE7H,KAAK,qCAAqC,GAAG;IAC5C,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACvC,CAAC;AAEF,KAAK,qCAAqC,GAAG;IAC5C,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,oBAAoB,GAAG;IAAE,OAAO,EAAE,yBAAyB,EAAE,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,iBAAiB,CAAA;CAAE,GAAG;IAC5I,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/esm/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,31 @@
+{
+	"name": "@athoscommerce/snap-client",
+	"version": "1.0.0",
+	"description": "Snap Client",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"author": "Athos Commerce",
+	"license": "MIT",
+	"repository": "https://github.com/athoscommerce/snap",
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "rm -rf ./dist && rm -fr ./components/dist && tsc & p1=$!; tsc -p tsconfig.cjs.json & p2=$!; wait $p1 && wait $p2",
+		"build:docs": "typedoc --out docs src/index.ts",
+		"dev": "tsc --watch",
+		"format": "prettier --write 'src/**/*.{js,jsx,ts,tsx}'",
+		"lint": "eslint 'src/**/*.{js,jsx,ts,tsx}'",
+		"test": "jest",
+		"test:watch": "jest --watch"
+	},
+	"dependencies": {
+		"@athoscommerce/snap-toolbox": "1.0.0",
+		"deepmerge": "4.3.1"
+	},
+	"sideEffects": false,
+	"files": [
+		"dist/**/*"
+	],
+	"gitHead": "714fb2d140d44581a559a6025310f8df9e33e216"
+}