@djust-b2b/djust-front-sdk 3.0.0-beta.9 → 3.0.1

package/lib/services/custom-field/index.d.ts

@@ -0,0 +1,115 @@
+import type { GetCustomFieldParameters, GetCustomFieldResponse, PostMediaCustomFieldParameters, GetMediaUrlParameters } from "./definitions";
+/**
+ * 📋 Retrieves custom fields.
+ *
+ * This function fetches custom fields based on the provided parameters.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/custom-fields`
+ *
+ * | **Parameter**        | **Type**   | **Required** | **Description**                                                           |
+ * |----------------------|------------|--------------|---------------------------------------------------------------------------|
+ * | `fieldType`          | `string`   | ✅           | The type of custom field to retrieve.                                    |
+ * | `includeInactive`    | `boolean`  |              | Whether to include inactive custom fields in the response.               |
+ * | `limit`              | `number`   |              | The maximum number of custom fields to return.                           |
+ * | `offset`             | `number`   |              | The number of custom fields to skip before starting to collect results.  |
+ * | `sealedTarget`       | `string`  |              | Indicates whether the media should be sealed.                            |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetCustomFieldResponse>` containing the retrieved custom fields.
+ *
+ * 🛠 **Example Usage**:
+ * ```typescript
+ * const customFields = await getCustomFields({
+ *   fieldType: 'text',
+ *   includeInactive: false,
+ *   limit: 10,
+ *   offset: 0,
+ * });
+ * ```
+ *
+ * @param {GetCustomFieldParameters} params - The parameters for fetching custom fields:
+ *   - `fieldType` - The type of custom field to retrieve.
+ *   - `includeInactive` (optional) - Whether to include inactive custom fields.
+ *   - `limit` (optional) - The maximum number of fields to return.
+ *   - `offset` (optional) - The number of fields to skip before collecting results.
+ *
+ * @returns {Promise<GetCustomFieldResponse>} - The response containing the retrieved custom fields.
+ */
+export declare function getCustomFields(params: GetCustomFieldParameters): Promise<GetCustomFieldResponse>;
+/**
+ * 🎥 Publishes a media custom field.
+ *
+ * This function allows uploading a media file associated with a specific custom field.
+ *
+ * 🛠 **Endpoint**: `POST /v2/shop/custom-fields/{id}/media`
+ *
+ * | **Parameter**         | **Type**   | **Required** | **Description**                                                      |
+ * |-----------------------|------------|--------------|----------------------------------------------------------------------|
+ * | `id`                 | `string`   | ✅           | The ID of the custom field associated with the media.                |
+ * | `customFieldIdType`  | `string`   | ✅           | The type of the custom field identifier (e.g., `externalId`).        |
+ * | `sealedTarget`       | `boolean`  |              | Indicates whether the media should be sealed.                        |
+ * | `fileName`           | `string`   | ✅           | The name of the media file being uploaded.                           |
+ * | `fileSize`           | `number`   | ✅           | The size of the media file in bytes.                                 |
+ *
+ * 📤 **Returns**:
+ * A `Promise<string>` containing the URL where the media can be uploaded.
+ *
+ * 🛠 **Example Usage**:
+ * ```typescript
+ * const mediaUrl = await postMediaCustomField({
+ *   id: 'field1',
+ *   customFieldIdType: 'externalId',
+ *   sealedTarget: true,
+ *   fileName: 'image.jpg',
+ *   fileSize: 2048,
+ * });
+ * ```
+ *
+ * @param {PostMediaCustomFieldParameters} params - The parameters for uploading a media custom field:
+ *   - `id` - The ID of the custom field.
+ *   - `customFieldIdType` - The type of the custom field identifier.
+ *   - `sealedTarget` (optional) - Whether the media should be sealed.
+ *   - `fileName` - The name of the media file.
+ *   - `fileSize` - The size of the media file in bytes.
+ *
+ * @returns {Promise<string>} - The URL for uploading the media file.
+ */
+export declare function postMediaCustomField(params: PostMediaCustomFieldParameters): Promise<string>;
+/**
+ * 🎥 Gets the media URL for a custom field.
+ *
+ * @deprecated This endpoint is deprecated in the API and should not be used for new implementations.
+ *
+ * This function retrieves the media URL associated with a specific custom field.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/custom-fields/{id}/media`
+ *
+ * | **Parameter**         | **Type**   | **Required** | **Description**                                                      |
+ * |-----------------------|------------|--------------|----------------------------------------------------------------------|
+ * | `id`                  | `string`   | ✅           | The ID of the custom field associated with the media.                |
+ * | `customFieldIdType`   | `string`   |              | The type of the custom field identifier (BUSINESS_ID, EXTERNAL_ID).  |
+ * | `sealedTarget`        | `string`   |              | The sealed target type.                                              |
+ * | `fileUrl`             | `string`   | ✅           | The URL of the file to retrieve.                                     |
+ *
+ * 📤 **Returns**:
+ * A `Promise<string>` containing the media URL.
+ *
+ * 🛠 **Example Usage**:
+ * ```typescript
+ * const mediaUrl = await getMediaUrl({
+ *   id: 'field1',
+ *   customFieldIdType: 'EXTERNAL_ID',
+ *   fileUrl: 'https://example.com/image.jpg',
+ * });
+ * ```
+ *
+ * @param {GetMediaUrlParameters} params - The parameters for retrieving a media URL:
+ *   - `id` - The ID of the custom field.
+ *   - `customFieldIdType` (optional) - The type of the custom field identifier.
+ *   - `sealedTarget` (optional) - The sealed target type.
+ *   - `fileUrl` - The URL of the file to retrieve.
+ *
+ * @returns {Promise<string>} - The media URL.
+ */
+export declare function getMediaUrl(params: GetMediaUrlParameters): Promise<string>;
+//# sourceMappingURL=index.d.ts.map

package/lib/services/custom-field/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/custom-field/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,wBAAwB,EACxB,sBAAsB,EACtB,8BAA8B,EAC9B,qBAAqB,EACtB,MAAM,eAAe,CAAC;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,wBAAwB,GAC/B,OAAO,CAAC,sBAAsB,CAAC,CAQjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,8BAA8B,GACrC,OAAO,CAAC,MAAM,CAAC,CAWjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,MAAM,CAAC,CAUjB"}

package/lib/services/custom-field/index.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCustomFields = getCustomFields;
+exports.postMediaCustomField = postMediaCustomField;
+exports.getMediaUrl = getMediaUrl;
+const fetch_instance_1 = require("../../settings/fetch-instance");
+/**
+ * 📋 Retrieves custom fields.
+ *
+ * This function fetches custom fields based on the provided parameters.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/custom-fields`
+ *
+ * | **Parameter**        | **Type**   | **Required** | **Description**                                                           |
+ * |----------------------|------------|--------------|---------------------------------------------------------------------------|
+ * | `fieldType`          | `string`   | ✅           | The type of custom field to retrieve.                                    |
+ * | `includeInactive`    | `boolean`  |              | Whether to include inactive custom fields in the response.               |
+ * | `limit`              | `number`   |              | The maximum number of custom fields to return.                           |
+ * | `offset`             | `number`   |              | The number of custom fields to skip before starting to collect results.  |
+ * | `sealedTarget`       | `string`  |              | Indicates whether the media should be sealed.                            |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetCustomFieldResponse>` containing the retrieved custom fields.
+ *
+ * 🛠 **Example Usage**:
+ * ```typescript
+ * const customFields = await getCustomFields({
+ *   fieldType: 'text',
+ *   includeInactive: false,
+ *   limit: 10,
+ *   offset: 0,
+ * });
+ * ```
+ *
+ * @param {GetCustomFieldParameters} params - The parameters for fetching custom fields:
+ *   - `fieldType` - The type of custom field to retrieve.
+ *   - `includeInactive` (optional) - Whether to include inactive custom fields.
+ *   - `limit` (optional) - The maximum number of fields to return.
+ *   - `offset` (optional) - The number of fields to skip before collecting results.
+ *
+ * @returns {Promise<GetCustomFieldResponse>} - The response containing the retrieved custom fields.
+ */
+async function getCustomFields(params) {
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/shop/custom-fields`,
+        params,
+    });
+    return data;
+}
+/**
+ * 🎥 Publishes a media custom field.
+ *
+ * This function allows uploading a media file associated with a specific custom field.
+ *
+ * 🛠 **Endpoint**: `POST /v2/shop/custom-fields/{id}/media`
+ *
+ * | **Parameter**         | **Type**   | **Required** | **Description**                                                      |
+ * |-----------------------|------------|--------------|----------------------------------------------------------------------|
+ * | `id`                 | `string`   | ✅           | The ID of the custom field associated with the media.                |
+ * | `customFieldIdType`  | `string`   | ✅           | The type of the custom field identifier (e.g., `externalId`).        |
+ * | `sealedTarget`       | `boolean`  |              | Indicates whether the media should be sealed.                        |
+ * | `fileName`           | `string`   | ✅           | The name of the media file being uploaded.                           |
+ * | `fileSize`           | `number`   | ✅           | The size of the media file in bytes.                                 |
+ *
+ * 📤 **Returns**:
+ * A `Promise<string>` containing the URL where the media can be uploaded.
+ *
+ * 🛠 **Example Usage**:
+ * ```typescript
+ * const mediaUrl = await postMediaCustomField({
+ *   id: 'field1',
+ *   customFieldIdType: 'externalId',
+ *   sealedTarget: true,
+ *   fileName: 'image.jpg',
+ *   fileSize: 2048,
+ * });
+ * ```
+ *
+ * @param {PostMediaCustomFieldParameters} params - The parameters for uploading a media custom field:
+ *   - `id` - The ID of the custom field.
+ *   - `customFieldIdType` - The type of the custom field identifier.
+ *   - `sealedTarget` (optional) - Whether the media should be sealed.
+ *   - `fileName` - The name of the media file.
+ *   - `fileSize` - The size of the media file in bytes.
+ *
+ * @returns {Promise<string>} - The URL for uploading the media file.
+ */
+async function postMediaCustomField(params) {
+    const { id, customFieldIdType, sealedTarget, fileName, fileSize } = params;
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "POST",
+        path: `/v1/shop/custom-fields/${id}/media`,
+        body: "",
+        params: { customFieldIdType, sealedTarget, fileName, fileSize },
+    });
+    return data;
+}
+/**
+ * 🎥 Gets the media URL for a custom field.
+ *
+ * @deprecated This endpoint is deprecated in the API and should not be used for new implementations.
+ *
+ * This function retrieves the media URL associated with a specific custom field.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/custom-fields/{id}/media`
+ *
+ * | **Parameter**         | **Type**   | **Required** | **Description**                                                      |
+ * |-----------------------|------------|--------------|----------------------------------------------------------------------|
+ * | `id`                  | `string`   | ✅           | The ID of the custom field associated with the media.                |
+ * | `customFieldIdType`   | `string`   |              | The type of the custom field identifier (BUSINESS_ID, EXTERNAL_ID).  |
+ * | `sealedTarget`        | `string`   |              | The sealed target type.                                              |
+ * | `fileUrl`             | `string`   | ✅           | The URL of the file to retrieve.                                     |
+ *
+ * 📤 **Returns**:
+ * A `Promise<string>` containing the media URL.
+ *
+ * 🛠 **Example Usage**:
+ * ```typescript
+ * const mediaUrl = await getMediaUrl({
+ *   id: 'field1',
+ *   customFieldIdType: 'EXTERNAL_ID',
+ *   fileUrl: 'https://example.com/image.jpg',
+ * });
+ * ```
+ *
+ * @param {GetMediaUrlParameters} params - The parameters for retrieving a media URL:
+ *   - `id` - The ID of the custom field.
+ *   - `customFieldIdType` (optional) - The type of the custom field identifier.
+ *   - `sealedTarget` (optional) - The sealed target type.
+ *   - `fileUrl` - The URL of the file to retrieve.
+ *
+ * @returns {Promise<string>} - The media URL.
+ */
+async function getMediaUrl(params) {
+    const { id, ...queryParams } = params;
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/shop/custom-fields/${id}/media`,
+        params: queryParams,
+    });
+    return data;
+}
+//# sourceMappingURL=index.js.map

package/lib/services/custom-field/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/custom-field/index.ts"],"names":[],"mappings":";;AA4CA,0CAUC;AAwCD,oDAaC;AAsCD,kCAYC;AA7JD,kEAA8D;AAQ9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACI,KAAK,UAAU,eAAe,CACnC,MAAgC;IAEhC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAA,8BAAa,EAAyB;QAC3D,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,wBAAwB;QAC9B,MAAM;KACP,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACI,KAAK,UAAU,oBAAoB,CACxC,MAAsC;IAEtC,MAAM,EAAE,EAAE,EAAE,iBAAiB,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAE3E,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAA,8BAAa,EAAS;QAC3C,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,0BAA0B,EAAE,QAAQ;QAC1C,IAAI,EAAE,EAAE;QACR,MAAM,EAAE,EAAE,iBAAiB,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE;KAChE,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACI,KAAK,UAAU,WAAW,CAC/B,MAA6B;IAE7B,MAAM,EAAE,EAAE,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;IAEtC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAA,8BAAa,EAAS;QAC3C,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,0BAA0B,EAAE,QAAQ;QAC1C,MAAM,EAAE,WAAW;KACpB,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC;AACd,CAAC"}

package/lib/services/custom-field/module.d.ts

@@ -0,0 +1,11 @@
+/**
+ * DJUST SDK Custom Field Module
+ * Re-exports all custom field-related types and service.
+ *
+ * @module services/custom-field
+ * @since 2.17.0
+ */
+export type { CustomFieldIdType, CustomFieldType, GetCustomFieldsParams, PostMediaCustomFieldParams, GetMediaUrlParams, CustomField, CustomFieldOption, GetCustomFieldsResponse, } from "./types";
+export { CustomFieldEndpoints, type CustomFieldEndpoint } from "./endpoints";
+export { CustomFieldService } from "./custom-field.service";
+//# sourceMappingURL=module.d.ts.map

package/lib/services/custom-field/module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../../src/services/custom-field/module.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,YAAY,EACV,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,0BAA0B,EAC1B,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,oBAAoB,EAAE,KAAK,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC"}

package/lib/services/custom-field/module.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * DJUST SDK Custom Field Module
+ * Re-exports all custom field-related types and service.
+ *
+ * @module services/custom-field
+ * @since 2.17.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomFieldService = exports.CustomFieldEndpoints = void 0;
+var endpoints_1 = require("./endpoints");
+Object.defineProperty(exports, "CustomFieldEndpoints", { enumerable: true, get: function () { return endpoints_1.CustomFieldEndpoints; } });
+var custom_field_service_1 = require("./custom-field.service");
+Object.defineProperty(exports, "CustomFieldService", { enumerable: true, get: function () { return custom_field_service_1.CustomFieldService; } });
+//# sourceMappingURL=module.js.map

package/lib/services/custom-field/module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../../src/services/custom-field/module.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAaH,yCAA6E;AAApE,iHAAA,oBAAoB,OAAA;AAC7B,+DAA4D;AAAnD,0HAAA,kBAAkB,OAAA"}

package/lib/services/custom-field/types.d.ts

@@ -0,0 +1,51 @@
+/**
+ * DJUST SDK Custom Field Service - Types
+ * Type definitions for custom field operations.
+ *
+ * @module services/custom-field/types
+ * @since 2.17.0
+ */
+export type CustomFieldIdType = "BUSINESS_ID" | "EXTERNAL_ID";
+export type CustomFieldType = "TEXT" | "NUMBER" | "BOOLEAN" | "DATE" | "DATETIME" | "SELECT" | "MULTI_SELECT" | "MEDIA";
+export interface GetCustomFieldsParams {
+    fieldType: string;
+    includeInactive?: boolean;
+    limit?: number;
+    offset?: number;
+    sealedTarget?: string;
+}
+export interface PostMediaCustomFieldParams {
+    id: string;
+    customFieldIdType: string;
+    fileName: string;
+    fileSize: number;
+    sealedTarget?: boolean;
+}
+/** @deprecated */
+export interface GetMediaUrlParams {
+    id: string;
+    fileUrl: string;
+    customFieldIdType?: CustomFieldIdType;
+    sealedTarget?: string;
+}
+export interface CustomField {
+    id: string;
+    externalId?: string;
+    name: string;
+    code: string;
+    type: CustomFieldType;
+    required: boolean;
+    active: boolean;
+    description?: string;
+    options?: CustomFieldOption[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CustomFieldOption {
+    id: string;
+    value: string;
+    label?: string;
+    position: number;
+}
+export type GetCustomFieldsResponse = CustomField[];
+//# sourceMappingURL=types.d.ts.map

package/lib/services/custom-field/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/services/custom-field/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAMH,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG,aAAa,CAAC;AAC9D,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,QAAQ,GACR,cAAc,GACd,OAAO,CAAC;AAMZ,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,kBAAkB;AAClB,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAMD,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,eAAe,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAGD,MAAM,MAAM,uBAAuB,GAAG,WAAW,EAAE,CAAC"}

package/lib/services/custom-field/types.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * DJUST SDK Custom Field Service - Types
+ * Type definitions for custom field operations.
+ *
+ * @module services/custom-field/types
+ * @since 2.17.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/services/custom-field/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/custom-field/types.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG"}