nextemos 2.1.3 → 2.1.5

package/dist/enums/httpMethods.d.ts

@@ -0,0 +1,60 @@
+/**
+ * HTTP request methods.
+ *
+ * HTTP defines a set of request methods to indicate the desired action to be
+ * performed for a given resource. Although they can also be nouns, these
+ * request methods are sometimes referred as HTTP verbs. Each of them implements
+ * a different semantic, but some common features are shared by a group of them:
+ * e.g. a request method can be safe, idempotent, or cacheable.
+ *
+ * @public
+ */
+export declare enum HTTPMethod {
+    /**
+     * The `CONNECT` method establishes a tunnel to the server identified by the
+     * target resource.
+     */
+    CONNECT = "CONNECT",
+    /**
+     * The `DELETE` method deletes the specified resource.
+     */
+    DELETE = "DELETE",
+    /**
+     * The `GET` method requests a representation of the specified resource.
+     * Requests using GET should only retrieve data.
+     */
+    GET = "GET",
+    /**
+     * The `HEAD` method asks for a response identical to that of a GET request,
+     * but without the response body.
+     */
+    HEAD = "HEAD",
+    /**
+     * The `OPTIONS` method is used to describe the communication options for the
+     * target resource.
+     */
+    OPTIONS = "OPTIONS",
+    /**
+     * The PATCH method is used to apply partial modifications to a resource.
+     */
+    PATCH = "PATCH",
+    /**
+     * The `POST` method is used to submit an entity to the specified resource,
+     * often causing a change in state or side effects on the server.
+     */
+    POST = "POST",
+    /**
+     * The `PUT` method replaces all current representations of the target
+     * resource with the request payload.
+     */
+    PUT = "PUT",
+    /**
+     * The `TRACE` method performs a message loop-back test along the path to the
+     * target resource.
+     */
+    TRACE = "TRACE"
+}
+/**
+ * @public
+ */
+export default HTTPMethod;

package/dist/enums/httpMethods.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HTTPMethod = void 0;
+/**
+ * HTTP request methods.
+ *
+ * HTTP defines a set of request methods to indicate the desired action to be
+ * performed for a given resource. Although they can also be nouns, these
+ * request methods are sometimes referred as HTTP verbs. Each of them implements
+ * a different semantic, but some common features are shared by a group of them:
+ * e.g. a request method can be safe, idempotent, or cacheable.
+ *
+ * @public
+ */
+var HTTPMethod;
+(function (HTTPMethod) {
+    /**
+     * The `CONNECT` method establishes a tunnel to the server identified by the
+     * target resource.
+     */
+    HTTPMethod["CONNECT"] = "CONNECT";
+    /**
+     * The `DELETE` method deletes the specified resource.
+     */
+    HTTPMethod["DELETE"] = "DELETE";
+    /**
+     * The `GET` method requests a representation of the specified resource.
+     * Requests using GET should only retrieve data.
+     */
+    HTTPMethod["GET"] = "GET";
+    /**
+     * The `HEAD` method asks for a response identical to that of a GET request,
+     * but without the response body.
+     */
+    HTTPMethod["HEAD"] = "HEAD";
+    /**
+     * The `OPTIONS` method is used to describe the communication options for the
+     * target resource.
+     */
+    HTTPMethod["OPTIONS"] = "OPTIONS";
+    /**
+     * The PATCH method is used to apply partial modifications to a resource.
+     */
+    HTTPMethod["PATCH"] = "PATCH";
+    /**
+     * The `POST` method is used to submit an entity to the specified resource,
+     * often causing a change in state or side effects on the server.
+     */
+    HTTPMethod["POST"] = "POST";
+    /**
+     * The `PUT` method replaces all current representations of the target
+     * resource with the request payload.
+     */
+    HTTPMethod["PUT"] = "PUT";
+    /**
+     * The `TRACE` method performs a message loop-back test along the path to the
+     * target resource.
+     */
+    HTTPMethod["TRACE"] = "TRACE";
+})(HTTPMethod || (exports.HTTPMethod = HTTPMethod = {}));
+/**
+ * @public
+ */
+exports.default = HTTPMethod;

package/dist/enums/index.d.ts

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

package/dist/enums/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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("./httpMethods"), exports);

package/dist/helpers/fetchRequest.d.ts

@@ -1,9 +1,6 @@
-interface APIResponse<T = any> {
-    data?: T;
-    error?: string;
-    status: number;
-}
-type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | 'CONNECT' | 'TRACE';
+import { IApiResponse } from 'nextemos/interfaces/';
+import { HTTPMethod as httpMethods } from 'nextemos/enums';
+type HTTPMethod = httpMethods;
 interface RequestOptions extends RequestInit {
     url: string;
     method: HTTPMethod;
@@ -14,9 +11,9 @@ interface RequestOptions extends RequestInit {
  * @returns {object} HTTP client with methods for making requests.
  */
 declare const fetchRequest: () => {
-    get: <T>(url: string, options?: Omit<RequestOptions, 'method'>) => Promise<APIResponse<T>>;
-    post: <T_1>(url: string, data: any, options?: Omit<RequestOptions, 'method'>) => Promise<APIResponse<T_1>>;
-    put: <T_2>(url: string, data: any, options?: Omit<RequestOptions, 'method'>) => Promise<APIResponse<T_2>>;
-    delete: <T_3>(url: string, options?: Omit<RequestOptions, 'method'>) => Promise<APIResponse<T_3>>;
+    get: <T>(url: string, options?: Omit<RequestOptions, 'method'>) => Promise<IApiResponse<T>>;
+    post: <T_1>(url: string, data: any, options?: Omit<RequestOptions, 'method'>) => Promise<IApiResponse<T_1>>;
+    put: <T_2>(url: string, data: any, options?: Omit<RequestOptions, 'method'>) => Promise<IApiResponse<T_2>>;
+    delete: <T_3>(url: string, options?: Omit<RequestOptions, 'method'>) => Promise<IApiResponse<T_3>>;
 };
 export default fetchRequest;

package/dist/helpers/fetchRequest.js

@@ -20,6 +20,8 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+// enums
+const enums_1 = require("nextemos/enums");
 /**
  * Creates a HTTP client for making requests.
  * @returns {object} HTTP client with methods for making requests.
@@ -29,7 +31,7 @@ const fetchRequest = () => {
      * Makes an HTTP request using fetch.
      * @template T
      * @param {RequestOptions} options - Request options.
-     * @returns {Promise<APIResponse<T>>} Response from the API.
+     * @returns {Promise<IApiResponse<T>>} Response from the API.
      */
     const request = (_a) => __awaiter(void 0, void 0, void 0, function* () {
         var { url, method, params } = _a, requestOptions = __rest(_a, ["url", "method", "params"]);
@@ -57,10 +59,10 @@ const fetchRequest = () => {
      * @template T
      * @param {string} url - Endpoint URL.
      * @param {RequestOptions} [options] - Request options.
-     * @returns {Promise<APIResponse<T>>} Response from the API.
+     * @returns {Promise<IApiResponse<T>>} Response from the API.
      */
     const get = (url, options) => __awaiter(void 0, void 0, void 0, function* () {
-        return yield request(Object.assign(Object.assign({}, options), { method: 'GET', url }));
+        return yield request(Object.assign(Object.assign({}, options), { method: enums_1.HTTPMethod.GET, url }));
     });
     /**
      * Makes a POST request.
@@ -68,10 +70,10 @@ const fetchRequest = () => {
      * @param {string} url - Endpoint URL.
      * @param {any} data - Request payload.
      * @param {RequestOptions} [options] - Request options.
-     * @returns {Promise<APIResponse<T>>} Response from the API.
+     * @returns {Promise<IApiResponse<T>>} Response from the API.
      */
     const post = (url, data, options) => __awaiter(void 0, void 0, void 0, function* () {
-        return yield request(Object.assign(Object.assign({}, options), { method: 'POST', url, body: data }));
+        return yield request(Object.assign(Object.assign({}, options), { method: enums_1.HTTPMethod.POST, url, body: data }));
     });
     /**
      * Makes a PUT request.
@@ -79,20 +81,20 @@ const fetchRequest = () => {
      * @param {string} url - Endpoint URL.
      * @param {any} data - Request payload.
      * @param {RequestOptions} [options] - Request options.
-     * @returns {Promise<APIResponse<T>>} Response from the API.
+     * @returns {Promise<IApiResponse<T>>} Response from the API.
      */
     const put = (url, data, options) => __awaiter(void 0, void 0, void 0, function* () {
-        return yield request(Object.assign(Object.assign({}, options), { method: 'PUT', url, body: data }));
+        return yield request(Object.assign(Object.assign({}, options), { method: enums_1.HTTPMethod.PUT, url, body: data }));
     });
     /**
      * Makes a DELETE request.
      * @template T
      * @param {string} url - Endpoint URL.
      * @param {RequestOptions} [options] - Request options.
-     * @returns {Promise<APIResponse<T>>} Response from the API.
+     * @returns {Promise<IApiResponse<T>>} Response from the API.
      */
     const remove = (url, options) => __awaiter(void 0, void 0, void 0, function* () {
-        return yield request(Object.assign(Object.assign({}, options), { method: 'DELETE', url }));
+        return yield request(Object.assign(Object.assign({}, options), { method: enums_1.HTTPMethod.DELETE, url }));
     });
     return {
         get,

package/dist/index.d.ts

@@ -1,3 +1,5 @@
 export * from './helpers';
 export * from './hooks';
 export * from './interfaces';
+export * from './enums';
+export * from './services';

package/dist/index.js

@@ -17,3 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./helpers"), exports);
 __exportStar(require("./hooks"), exports);
 __exportStar(require("./interfaces"), exports);
+__exportStar(require("./enums"), exports);
+__exportStar(require("./services"), exports);

package/dist/interfaces/index.d.ts

@@ -1,2 +1,3 @@
 export * from './elements';
 export * from './banner';
+export * from './response';

package/dist/interfaces/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /// interfaces
 __exportStar(require("./elements"), exports);
 __exportStar(require("./banner"), exports);
+__exportStar(require("./response"), exports);

package/dist/interfaces/response.d.ts

@@ -1,64 +1,86 @@
 /**
- * The IResponse interface represents the structure of a standard response object returned by an API.
- * It contains various properties to convey the success status, additional messages, and scripts to be executed on the client side.
+ * APIResponse arayüzü, genel API yanıtlarını temsil eder.
+ *
+ * @template T - Döndürülen veri türü (varsayılan: any).
+ */
+export interface IApiResponse<T = any> {
+    /**
+     * API'den döndürülen veriler.
+     * Bu alan opsiyoneldir ve API çağrısı başarılı olduğunda kullanılır.
+     */
+    data?: T;
+    /**
+     * API çağrısı sırasında meydana gelen hata mesajı.
+     * Bu alan opsiyoneldir ve API çağrısı başarısız olduğunda kullanılır.
+     */
+    error?: string;
+    /**
+     * HTTP durum kodu.
+     * Bu alan, API çağrısının HTTP durum kodunu belirtir (ör. 200, 404, 500).
+     */
+    status: number;
+}
+/**
+ * IResponse arayüzü, bir API tarafından döndürülen standart yanıt nesnesinin yapısını temsil eder.
+ * Başarı durumu, ek mesajlar ve istemci tarafında yürütülecek betikler gibi çeşitli özellikler içerir.
  */
 export interface IResponse {
     /**
-     * Indicates whether the API request was successful (true) or not (false).
+     * API isteğinin başarılı olup olmadığını belirtir (true: başarılı, false: başarısız).
      */
     isSuccess: boolean;
     /**
-     * A string representing the status code of the API response. This can be used to convey specific success or error codes.
+     * API yanıtının durum kodunu temsil eden bir dize. Bu, belirli başarı veya hata kodlarını iletmek için kullanılabilir.
      */
     statusCode: string;
     /**
-     * A message providing additional details about the response. This can be used for error messages or success confirmations.
+     * Yanıt hakkında ek bilgiler sağlayan bir mesaj. Bu, hata mesajları veya başarı teyitleri için kullanılabilir.
      */
     message: string;
     /**
-     * A script to be executed on the client side after the response is processed. This could be JavaScript code for dynamic updates or other purposes.
+     * Yanıt işlendiğinde istemci tarafında yürütülecek bir betik. Bu, dinamik güncellemeler veya diğer amaçlar için JavaScript kodu olabilir.
      */
     script: string;
     /**
-     * A script to be inserted and executed in the <head> section of the HTML document. This is useful for scripts that need to be loaded before the rest of the page content.
+     * HTML belgesinin <head> bölümüne eklenip yürütülecek bir betik. Bu, sayfa içeriğinden önce yüklenmesi gereken betikler için kullanışlıdır.
      */
     headerScript: string;
     /**
-     * A script to be inserted and executed at the end of the HTML document, typically before the closing </body> tag. This is useful for scripts that depend on the DOM being fully loaded.
+     * HTML belgesinin sonunda, genellikle kapanış </body> etiketinden önce eklenip yürütülecek bir betik. Bu, DOM tamamen yüklendikten sonra çalışması gereken betikler için kullanışlıdır.
      */
     footerScript: string;
     /**
-     * A string indicating whether the environment should be refreshed. This can be used to trigger a reload or reset of certain parts of the application.
+     * Ortamın yenilenmesi gerekip gerekmediğini belirten bir dize. Bu, uygulamanın belirli bölümlerinin yeniden yüklenmesini veya sıfırlanmasını tetiklemek için kullanılabilir.
      */
     refreshEnvironment: string;
     /**
-     * An array of strings representing tags associated with the response. Tags can be used for categorization, filtering, or other metadata purposes.
+     * Yanıtla ilişkilendirilen etiketleri temsil eden bir dize dizisi. Etiketler, kategorize etme, filtreleme veya diğer meta veri amaçları için kullanılabilir.
      */
     tags: string[];
 }
 /**
- * The IResponsePaging interface extends the IResponse interface to include additional properties for handling paginated responses.
- * This is useful for responses that return large datasets spread across multiple pages.
+ * IResponsePaging arayüzü, IResponse arayüzünü genişleterek sayfalanmış yanıtları işlemek için ek özellikler içerir.
+ * Bu, büyük veri kümelerinin birden fazla sayfaya yayıldığı yanıtlar için kullanışlıdır.
  */
 export interface IResponsePaging extends IResponse {
     /**
-     * The total number of items available across all pages. This is useful for understanding the size of the dataset.
+     * Tüm sayfalardaki toplam öğe sayısı. Bu, veri kümesinin büyüklüğünü anlamak için kullanışlıdır.
      */
     totalItems: number;
     /**
-     * The number of items taken (or returned) in the current response. This typically corresponds to the page size or a subset of it.
+     * Mevcut yanıtta döndürülen öğe sayısı. Bu genellikle sayfa boyutuna veya onun bir alt kümesine karşılık gelir.
      */
     taked: number;
     /**
-     * The number of items skipped from the beginning of the dataset. This is useful for determining the starting point of the current page of data.
+     * Veri kümesinin başından itibaren atlanan öğe sayısı. Bu, mevcut sayfanın veri kümesindeki başlangıç noktasını belirlemek için kullanışlıdır.
      */
     skipped: number;
     /**
-     * The number of items to be displayed per page. This helps in controlling the amount of data shown on each page.
+     * Sayfa başına gösterilecek öğe sayısı. Bu, her sayfada gösterilen veri miktarını kontrol etmeye yardımcı olur.
      */
     pageSize: number;
     /**
-     * The current page number being displayed. This helps in navigating through the paginated dataset.
+     * Görüntülenen mevcut sayfa numarası. Bu, sayfalı veri kümesinde gezinmeye yardımcı olur.
      */
     currentPage: number;
 }

package/dist/services/banner.d.ts

@@ -0,0 +1,33 @@
+import { IApiResponse, IBannerResponse, IBannersResponse } from 'nextemos/interfaces';
+/**
+ * BannerService arayüzü, Banner ile ilgili API çağrılarını temsil eder.
+ * Banner ile ilgili çeşitli verileri almak için kullanılabilecek metotlar içerir.
+ */
+interface BannerService {
+    /**
+     * Belirli bir ID'ye sahip banner'ı getirir.
+     * @returns Belirli bir ID'ye sahip banner verilerini içeren bir API yanıtı.
+     */
+    GetBannerById: () => Promise<IApiResponse<IBannerResponse>>;
+    /**
+     * Belirli bir isme sahip banner'ı getirir.
+     * @returns Belirli bir isme sahip banner verilerini içeren bir API yanıtı.
+     */
+    GetBannerByName: () => Promise<IApiResponse<IBannerResponse>>;
+    /**
+     * Belirli bir anahtara sahip banner'ı getirir.
+     * @returns Belirli bir anahtara sahip banner verilerini içeren bir API yanıtı.
+     */
+    GetBannerByKey: () => Promise<IApiResponse<IBannerResponse>>;
+    /**
+     * Banner listesini getirir.
+     * @returns Banner listesini içeren bir API yanıtı.
+     */
+    GetBannerList: () => Promise<IApiResponse<IBannersResponse>>;
+}
+/**
+ * @constant Banner
+ * @description Banner ile ilgili hizmetleri sağlayan nesne. BannerService arayüzünü uygular.
+ */
+export declare const Banner: BannerService;
+export {};

package/dist/services/banner.js

@@ -0,0 +1,49 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Banner = void 0;
+// URL'lerin bulunduğu dosyayı içe aktarır
+const urls_1 = __importDefault(require("./urls"));
+// Yardımcı fonksiyonları içe aktarır
+const helpers_1 = require("nextemos/helpers");
+/**
+ * @constant Banner
+ * @description Banner ile ilgili hizmetleri sağlayan nesne. BannerService arayüzünü uygular.
+ */
+exports.Banner = {
+    /**
+     * @method
+     * @description Belirli bir ID'ye sahip banner'ı getirir.
+     * @returns {Promise<IApiResponse<IBannerResponse>>} Belirli bir ID'ye sahip banner verilerini içeren bir API yanıtı.
+     */
+    GetBannerById: () => __awaiter(void 0, void 0, void 0, function* () { return yield (0, helpers_1.fetchRequest)().get(urls_1.default.Banner.GetBannerById); }),
+    /**
+     * @method
+     * @description Belirli bir isme sahip banner'ı getirir.
+     * @returns {Promise<IApiResponse<IBannerResponse>>} Belirli bir isme sahip banner verilerini içeren bir API yanıtı.
+     */
+    GetBannerByName: () => __awaiter(void 0, void 0, void 0, function* () { return yield (0, helpers_1.fetchRequest)().get(urls_1.default.Banner.GetBannerByName); }),
+    /**
+     * @method
+     * @description Belirli bir anahtara sahip banner'ı getirir.
+     * @returns {Promise<IApiResponse<IBannerResponse>>} Belirli bir anahtara sahip banner verilerini içeren bir API yanıtı.
+     */
+    GetBannerByKey: () => __awaiter(void 0, void 0, void 0, function* () { return yield (0, helpers_1.fetchRequest)().get(urls_1.default.Banner.GetBannerByKey); }),
+    /**
+     * @method
+     * @description Banner listesini getirir.
+     * @returns {Promise<IApiResponse<IBannersResponse>>} Banner listesini içeren bir API yanıtı.
+     */
+    GetBannerList: () => __awaiter(void 0, void 0, void 0, function* () { return yield (0, helpers_1.fetchRequest)().get(urls_1.default.Banner.GetBannerList); }),
+};

package/dist/services/index.d.ts

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

package/dist/services/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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 });
+// services
+__exportStar(require("./banner"), exports);

package/dist/services/urls.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    Banner: {
+        GetBannerById: string;
+        GetBannerByName: string;
+        GetBannerByKey: string;
+        GetBannerList: string;
+        GetBannerContainerList: string;
+    };
+};
+export default _default;

package/dist/services/urls.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    Banner: {
+        GetBannerById: '/api/banner/{language}/Banner/v1/GetBannerById',
+        GetBannerByName: '/api/banner/{language}/Banner/v1/GetBannerByName',
+        GetBannerByKey: '/api/banner/{language}/Banner/v1/GetBannerByKey',
+        GetBannerList: '/api/banner/{language}/Banner/v1/GetBannerList',
+        GetBannerContainerList: '/api/banner/{language}/Banner/v1/GetBannerContainerList',
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nextemos",
-  "version": "2.1.3",
+  "version": "2.1.5",
   "description": "For helpers and hooks used in NextJS projects",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",