oneentry 1.0.149 → 1.0.151

package/README.md

@@ -46,6 +46,7 @@ const {
     Discounts,
     Events,
     FileUploading,
+    Filters,
     Forms,
     FormData,
     GeneralTypes,
@@ -58,9 +59,11 @@ const {
     Products,
     ProductStatuses,
     Sitemap,
+    Subscriptions,
     System,
     Templates,
     TemplatePreviews,
+    UserActivity,
     Users,
     WS,
 } = defineOneEntry('your-url', config)
@@ -85,6 +88,8 @@ The second parameter of the constructor takes the 'config'. It contains the foll
 
 - 'langCode' - Set the "langCode" to set the default language. By specifying this parameter once, you don't have to pass the langCode to the methods ONEENTRY API. If you have not passed the default language, it will be set "en_US".
 
+- 'guestId' - Optional guest identifier sent as the "x-guest-id" header on unauthenticated requests. It enables guest cart / wishlist / activity flows. In the browser, if you omit it, the SDK generates a stable id and persists it in localStorage. On the server you must pass a per-visitor "guestId" (or call "setGuestId"): the SDK never auto-generates a server id, to avoid sharing one guest across visitors. The header is omitted once a user is authenticated.
+
 - 'traficLimit' - Some methods use more than one request to the CMS so that the data you receive is complete and easy to work with. Pass the value "true" for this parameter to save traffic and decide for yourself what data you need. The default value "false".
 
 - 'auth' - An object with authorization settings. By default, the SDK is configured to work with tokens inside the user's session and does not require any additional work from you. At the same time, the SDK does not store the session state between sessions. If you are satisfied with such settings, do not pass the variable 'auth' at all.
@@ -218,6 +223,7 @@ Now you can use the following links to jump to specific entries documentation:
 - [Discounts](https://js-sdk.oneentry.cloud/docs/category/discounts)
 - [Events](https://js-sdk.oneentry.cloud/docs/category/events)
 - [FileUploading](https://js-sdk.oneentry.cloud/docs/category/fileuploading)
+- [Filters](https://js-sdk.oneentry.cloud/docs/category/filters)
 - [Forms](https://js-sdk.oneentry.cloud/docs/category/forms-1)
 - [FormData](https://js-sdk.oneentry.cloud/docs/category/formdata)
 - [GeneralTypes](https://js-sdk.oneentry.cloud/docs/category/generaltypes)
@@ -230,9 +236,11 @@ Now you can use the following links to jump to specific entries documentation:
 - [ProductStatuses](https://js-sdk.oneentry.cloud/docs/category/productstatuses)
 - [Products](https://js-sdk.oneentry.cloud/docs/category/products-1)
 - [Sitemap](https://js-sdk.oneentry.cloud/docs/category/sitemap)
+- [Subscriptions](https://js-sdk.oneentry.cloud/docs/category/subscriptions)
 - [System](https://js-sdk.oneentry.cloud/docs/category/system)
 - [Templates](https://js-sdk.oneentry.cloud/docs/category/templates)
 - [TemplatePreviews](https://js-sdk.oneentry.cloud/docs/category/templatepreviews)
+- [UserActivity](https://js-sdk.oneentry.cloud/docs/category/useractivity)
 - [Users](https://js-sdk.oneentry.cloud/docs/category/users-1)
 - [WS](https://js-sdk.oneentry.cloud/docs/category/web-socket)
 - [Advanced examples](https://js-sdk.oneentry.cloud/docs/category/usage-examples)

package/changelog.md

@@ -0,0 +1,453 @@
+# SDK Change Log
+
+## v.1.0.151
+
+### What's New
+
+- Pages > `PageType` — new page-specific type union (`'catalog_page' | 'common_page' | 'error_page' | 'external_page'`), a page subset of `BlockType`.
+
+- Orders > `IOrderSplit`, `IOrderSplitStage` — new interfaces describing the split (staged) payment configuration returned by the by-id order endpoint.
+
+### What's Changed
+
+- Pages > `IPagesEntity.type` — now typed as the page-specific `PageType` instead of the broad `BlockType` (the value set is unchanged, just narrowed semantically). The page Zod schema validates `type` against the same set.
+
+- Pages > `IPagesEntity.categoryPath` — now `string | null` (was `string`); the API returns `null` for nested pages. Page Zod schema relaxed to `z.string().nullable().optional()`.
+
+- FormsData > `IPostFormResponseData.fingerprint` — now `string | null` (was `string`); anonymous / app-token submissions return `null`. `PostFormResponseSchema` relaxed to `z.string().nullable()` (previously rejected the real response under strict validation).
+
+- Orders > `IOrderDiscountConfig.bonus` — now optional (`bonus?`); the API omits the key entirely on orders without a bonus context (previously failed validation when embedded in create/update order responses).
+
+- Orders > `IOrderByMarkerEntity` — now exposes `discountConfig` (`IOrderDiscountConfig | null`), `totalSumRaw`, `isPartial` (`boolean | null`), `paymentStrategy`, and `split`; these fields are returned by the API and were previously stripped from the validated result. `OrderEntitySchema` extended accordingly, and `IOrderDiscountSettings` / `OrderDiscountConfigSchema.settings` gained `giftRefundPolicy`, `maxBonusPaymentPercent`, `minBonusAmount`, `minOrderAmountForBonus`.
+
+- FileUploading > `IUploadingReturn.contentType` — added (the upload endpoint always returns the file MIME type); `UploadingReturnSchema` extended with `contentType: z.string()`.
+
+## v.1.0.150
+
+### What's New
+
+- Subscriptions — new module for paid subscriptions:
+  - `subscribe` — create a new subscription and get a payment session.
+  - `cancelSubscription` — cancel a subscription.
+  - `getAllSubscriptions` — get all available subscription markers.
+  - `getActiveSubscriptions` — get markers of the user's active subscriptions.
+  - `recoverSubscriptions` — recover a subscription through the Stripe Billing Portal.
+  - `ISubscribe`, `ICancelSubscription`, `ICreatedSubscription` — new interfaces.
+
+- UserActivity — new module for tracking user/guest activity:
+  - `trackUserActivity` — record a user or guest activity event.
+  - `ITrackActivity`, `TUserActivityType` — new interfaces/types.
+
+- Filters — new module for content filters:
+  - `getFilterByMarker` — get a filter by its marker (items tree).
+  - `IContentFilter`, `IContentFilterItem`, `TContentFilterItemType` — new interfaces/types.
+
+- Users > `getCart`, `setCart`, `addCartItem`, `removeCartItem` — manage the current user's or guest's cart.
+
+- Users > `getWishlist`, `setWishlist`, `addWishlistItem`, `removeWishlistItem` — manage the current user's or guest's wishlist.
+
+- Users > `ICartResponse`, `ICartItem`, `ICartSet`, `ICartAddItem`, `IWishlistResponse`, `IWishlistItem`, `IWishlistSet`, `IWishlistAddItem` — new interfaces.
+
+- Blocks > `getCartComplement`, `getCartComplementByProductIds` — get "complete your cart" products (by cart context or explicit productIds).
+
+- Blocks > `getCartSimilar`, `getCartSimilarByProductIds` — get "similar to cart" products (by cart context or explicit productIds).
+
+- Blocks > `getWishlistSimilar`, `getWishlistSimilarByProductIds` — get "similar to wishlist" products (by wishlist context or explicit productIds).
+
+- Blocks > `getPersonalRecommendations` — get personal recommendations for the user.
+
+- Blocks > `getRecentlyViewed` — get recently viewed products.
+
+- Blocks > `getRepeatPurchase` — get products for repeat purchase.
+
+- Blocks > `getTrending` — get trending products of the block.
+
+- Blocks > `getSlides` — get the block's slides tree as a flat pre-order array (slider_block only).
+
+- Blocks > `IBlockProductsLookup`, `IContentSlidesResponse`, `IContentSlideItem` — new interfaces.
+
+- Events > `getAllEvents` — get all available events.
+
+- Events > `subscribeToForm`, `unsubscribeFromForm` — subscribe to / unsubscribe from form events by marker.
+
+- Events > `getFormSubscriptions` — get all form subscriptions.
+
+- Events > `IContentApiEvent`, `IListFormSubscription`, `ISubscribeFormEvent` — new interfaces.
+
+- Products > `getProductsByVectorSearch` — semantic (vector) search for products.
+
+- Products > `IVectorSearchProducts` — new interface.
+
+- Guest mode — the SDK now sends an `x-guest-id` header on unauthenticated requests, enabling guest cart/wishlist/activity flows:
+  - `config.guestId` — optional explicit guest identifier in `defineOneEntry`.
+  - `setGuestId(guestId)` — set/clear the guest identifier at runtime (chainable, like `setAccessToken`; pass `''` to clear).
+  - In the browser, when not provided, a stable id is generated (via Web Crypto when available) and persisted in `localStorage` (key `oneentry_guest_id`), mirroring the device-metadata strategy.
+  - On the server the SDK does NOT auto-generate a guest id (one shared `defineOneEntry` instance would otherwise leak a single guest cart across visitors) — pass a per-visitor `guestId` explicitly.
+  - The header is omitted for authenticated requests (when an access token is set).
+
+### What's Changed
+
+- Blocks > `BlockType` — added `'trending_block'`, `'recently_viewed_block'`, `'repeat_purchase_block'`, `'slider_block'`, `'personal_recommendations_block'`, `'cart_complement_block'`, `'cart_similar_block'`, `'wishlist_similar_block'` values.
+
+- Blocks > `getSimilarProducts` — added optional `productId` query parameter.
+
+## v.1.0.149
+
+### What's Changed
+
+- Captcha fix.
+
+## v.1.0.148
+
+### What's Changed
+
+- Small fixes.
+
+## v.1.0.147
+
+### What's Changed
+
+- Small fixes.
+
+## v.1.0.146
+
+### What's Changed
+
+- Small fixes.
+
+## v.1.0.145
+
+### What's Changed
+
+- Small fixes.
+
+## v.1.0.144
+
+### What's New
+
+- Blocks > `getFrequentlyOrderedProducts` — get frequently ordered products by block marker and product id.
+
+- Blocks > `BlockType` — added `'frequently_ordered_block'` value.
+
+- Discounts > `getBonusBalance` — get bonus balance of the current user.
+
+- Discounts > `getBonusHistory` — get bonus transaction history with filtering by type, date range, discount, module and admin flag.
+
+- Discounts > `IBonusTransactionEntity` — new interface for bonus transactions.
+
+- Orders > `getRefunds` — get all refund requests for an order.
+
+- Orders > `createRefundRequest` — create a refund request for an order.
+
+- Orders > `cancelRefundRequest` — cancel a refund request for an order.
+
+- Orders > `IRefundRequest` — new interface for refund requests.
+
+- Orders > `IBaseOrdersEntity` — added `bonusAmount`, `bonusApplied`, `totalDue` fields.
+
+- Orders > `IOrderData` — added `bonusAmount` field.
+
+- Orders > `ICreateOrderPreview` — added `bonusAmount` field.
+
+- Orders > `IOrderPreviewResponse` — added `bonusApplied`, `totalDue` fields.
+
+- Products > `IAggregatedProductGroup` — new interface for aggregated product groups.
+
+- Discounts > `IDiscountsEntity` — added `bonusEvent` field.
+
+- Forms > `IFormConfig` — added `exceptionIds` field.
+
+- Pages > `IPagesEntity` — added `rating` field.
+
+- Products > `IProductsEntity` — added `rating` field.
+
+- Users > `IUserEntity` — added `rating` field.
+
+### What's Changed
+
+- Discounts > `IDiscountsEntity.type` — removed `'PERSONAL_BONUS'` value.
+
+- Discounts > `getAllDiscounts` — removed `'PERSONAL_BONUS'` from type filter parameter.
+
+- Forms > `IFormsEntity` — type narrowed to `'order' | 'sing_in_up' | 'collection' | 'data' | 'rating'`, removed `moduleFormConfigs` field.
+
+- Products > `getProductsEmptyPage` — changed from GET to POST, added `body` parameter, return type changed to `IAggregatedProductGroup[]`.
+
+---
+
+## v.1.0.142
+
+### What's Changed
+
+- Small fixes.
+
+### Bug Fixes
+
+- `stateModule` — fixed default value of `isShell`: was `false` when `errors` config was not provided, now correctly defaults to `true` (matches documentation). Previously, omitting the `errors` config caused all API errors to be thrown as exceptions instead of being returned as `IError` objects.
+
+- `AuthProviderApi.auth()` — fixed token state being overwritten on failed auth: `state.accessToken` and `state.refreshToken` are now only updated when the response is a valid `IAuthEntity`, not when it is an `IError`.
+
+- `AuthProviderApi.refresh()` — same fix: tokens and `saveFunction` are now only invoked on successful response, preventing accidental token destruction on refresh failure.
+
+---
+
+## v.1.0.140
+
+### What's New
+
+- Discounts — new module with `getAllDiscounts`, `getDiscountByMarker` and `validateDiscountsCoupon` methods.
+
+- Orders > `previewOrder` — preview order calculation with discounts and coupons (without saving).
+
+- Orders > `getAllStatusesByStorageMarker` — get all statuses by storage marker.
+
+- Orders > `IOrderData` — added `couponCode` and `additionalDiscountsMarkers` fields.
+
+- Products > `getProductById` — added optional `isNormalized` parameter.
+
+- Products > `IFilterParams` — added `pageUrls` field (array).
+
+- Sitemap — new module with `updateSitemap` and `listSitemap` methods.
+
+### What's Changed
+
+- Orders > `IBaseOrdersEntity` — added `couponCode`, `additionalDiscountsMarkers`, `discountConfig` fields.
+
+- Orders > `IOrderByMarkerEntity` — added `statusLocalizeInfos` field.
+
+- Orders > `getOrderByMarker` — renamed to `getOrdersStorageByMarker`.
+
+### What's Deleted
+
+- System > validateCaptcha
+
+## v.1.0.139
+
+### What's Changed
+
+- Small fixes.
+
+## v.1.0.138
+
+### What's New
+
+- Added signPrice field to userQuery field for products
+
+### What's Changed
+
+- Small fixes.
+
+## v.1.0.137
+
+### What's New
+
+- Add Zod validation in critical modules
+
+### What's Changed
+
+- rename "oauthSignUp" to "oauth"
+
+- Small fixes.
+
+## v.1.0.136
+
+### What's New
+
+- Add "timeIntervals" field to AttributeSets
+
+- Add "timeIntervals" field to Forms attributes
+
+## v.1.0.135
+
+### What's New
+
+- FormData > updateFormsDataByid - Update one object of form data by id.
+
+- FormData > updateFormsDataStatusByid - Update one object of form data status by id.
+
+- FormData > deleteFormsDataByid - Delete one object of form data by id.
+
+### What's Changed
+
+- Small fixes.
+
+### What's Deleted
+
+- Payments > webhookByMarker
+
+---
+
+## v.1.0.134
+
+### What's Changed
+
+- Change formsData > getFormsDataByMarker - remove parameter isNested
+
+- Change formsData > getFormsDataByMarker - add parameter isExtended
+
+- Change formsData > getFormsDataByMarker - add body parameter entityparentIdentifier
+
+---
+
+## v.1.0.133
+
+### What's New
+
+- FileUploading > createFileFromUrl - Utility method. Create a File object from a URL for uploading file or use with formData.
+
+### What's Changed
+
+- Small fixes.
+
+### What's Deleted
+
+- FormsData > getFormsData
+
+---
+
+## v.1.0.132
+
+### What's Changed
+
+- Small fixes.
+
+---
+
+## v.1.0.131
+
+### What's Changed
+
+- Small fixes.
+
+---
+
+## v.1.0.130
+
+### What's New
+
+- Added `config.providerMarker` parameter to `defineOneentry` config
+
+---
+
+## v.1.0.129
+
+### What's Changed
+
+- Small fixes.
+
+---
+
+## v.1.0.128
+
+### What's Changed
+
+- Extend jsdoc comments.
+
+- Small fixes.
+
+---
+
+## v.1.0.127
+
+### What's Changed
+
+- Fixed some types errors. Improved fields descriptions.
+
+---
+
+## v.1.0.126
+
+### What's New
+
+- AuthProvider > oauthSignUp - User registration (authorizati09on) via OAUTH.
+
+- AuthProvider > logoutAll - Logout of user account on all devices.
+
+- AuthProvider > getActiveSessionsByMarker - Getting active user session data.
+
+- Payments > webhookByMarker - marker: This is a payment account marker.
+
+- Products > getProductsCount - Getting the number of products for the entire catalog.
+
+- Products > getProductsCountByPageId - Getting the number of products on a catalog page by page ID.
+
+- Products > getProductsCountByPageUrl - Getting the number of products on a catalog page by page URL.
+
+- System > getApiStat - Getting the number of requests to API
+
+- Users > archiveUser - Archiving one user object (marked for deletion).
+
+### What's Deleted
+
+- Payments > webhookStripe
+
+- Payments > getConnected
+
+- Pages > getFormsByPageUrl
+
+### What's Changed
+
+- AuthProvider > getMarker reanmed to getAuthProviderByMarker
+
+- FormData > postFormsData - changed the type of the input parameter body to IBodyPostFormData, changed output type to IPostFormResponse.
+
+- FormData > getFormsDataByMarker - input parameters scheme changed, changed output type to IFormsByMarkerDataEntity.
+
+- Payments > getAccountById - added payment account connection parameters to the settings field.
+
+  Example settings for stripe
+
+  ```json
+  {
+    "stripeAccountId": "acct_1RsDXzHy1QOsjfBI",
+    "stripeOnboardingComplete": true,
+    "stripePublishableKey": "pk_test_51OO...Y7MS3",
+    "successUrl": "https://example.com/success",
+    "cancelUrl": "https://example.com/cancel",
+    "sessionTimeout": 15
+  }
+  ```
+
+  Example settings for yookassa
+
+  ```json
+  {
+    "shopId": "1234567",
+    "secretKey": "test_pazk0r3JNlMEEwQq6t3Syk-qapXL0ArHvdXYxtaDvcv",
+    "successUrl": "https://example.com/success",
+    "cancelUrl": "https://example.com/cancel",
+    "sessionTimeout": 15
+  }
+  ```
+
+---
+
+## v.1.0.124
+
+### What's Changed
+
+- Admins > getAdminsInfo - old sdk version won't work with new data
+
+- FileUploading > getFile - Parameter 'filename' in query change into required
+
+- FileUploading > delete - Parameter 'filename' in query change into required
+
+- Products > getProductsByIds - Add ids in query / Delete ids in path
+
+- AuthProvider > changePassword - Add new required field eventIdentifier
+
+- Templates > getTemplateByType - Parameter 'type' in query change into not required
+
+What's Deleted
+
+- ProductStatuses > getProductStatusesById
+
+- Templates > getTemplateById
+
+- TemplatePreviews > getTemplatePreviewById
+
+---
+
+## v.1.0.0
+
+Initial relase

package/dist/base/asyncModules.js

@@ -308,6 +308,8 @@ class AsyncModules extends syncModules_1.default {
                 'x-app-token': this.state.token,
                 // Include the device fingerprint
                 'x-device-metadata': this._getDeviceMetadata(),
+                // x-guest-id is intentionally omitted: refresh is an auth-only call
+                // (a pure guest has no refresh token), so guest scoping does not apply.
             },
             body: JSON.stringify({ refreshToken: this.state.refreshToken }),
         });
@@ -344,6 +346,17 @@ class AsyncModules extends syncModules_1.default {
                 'x-app-token': this.state.token,
             },
         };
+        // Guest identifier — enables guest cart/wishlist/activity flows.
+        // Only sent for unauthenticated requests: once a user is logged in their
+        // own identity scopes the data, and sending the guest id would link the
+        // anonymous trail to the account. Omitted entirely when no id is available
+        // (e.g. server-side without an explicit guestId — see _getGuestId).
+        if (!this.state.accessToken) {
+            const guestId = this._getGuestId();
+            if (guestId) {
+                options.headers['x-guest-id'] = guestId;
+            }
+        }
         // if method = 'POST' add x-device-metadata
         if (method === 'POST') {
             options.headers = {

package/dist/base/stateModule.d.ts

@@ -7,6 +7,7 @@ export default class StateModule {
     url: string | undefined;
     lang: string | undefined;
     token: string | undefined;
+    guestId: string | undefined;
     accessToken: string | undefined;
     traficLimit: boolean;
     refreshToken: string | undefined;

package/dist/base/stateModule.js

@@ -49,6 +49,9 @@ class StateModule {
         this.url = url;
         this.lang = (_a = config.langCode) !== null && _a !== void 0 ? _a : 'en_US';
         this.token = config.token;
+        // Normalize empty string to undefined: an explicit '' must not masquerade
+        // as a set guest id (it would otherwise suppress id resolution).
+        this.guestId = config.guestId || undefined;
         this.traficLimit = config.traficLimit || false;
         this.validationEnabled = (_c = (_b = config.validation) === null || _b === void 0 ? void 0 : _b.enabled) !== null && _c !== void 0 ? _c : false;
         this.validationStrictMode = (_e = (_d = config.validation) === null || _d === void 0 ? void 0 : _d.strictMode) !== null && _e !== void 0 ? _e : false;

package/dist/base/syncModules.d.ts

@@ -14,6 +14,24 @@ export default abstract class SyncModules {
      * @param {StateModule} state - StateModule instance.
      */
     protected constructor(state: StateModule);
+    /**
+     * Resolves the guest identifier for the current request, or `undefined`.
+     *
+     * Resolution order:
+     * 1. An explicitly configured `state.guestId` (from config or `setGuestId`) — wins.
+     * 2. A persistent browser ID stored in localStorage (key `oneentry_guest_id`),
+     * stable across sessions and tabs — mirrors the device-metadata strategy.
+     * Once resolved it is cached into `state.guestId` (safe: one browser = one user).
+     * 3. Otherwise `undefined` — the `x-guest-id` header is simply omitted.
+     *
+     * IMPORTANT (server-side): the SDK never invents a guest id on the server.
+     * `defineOneEntry` is typically created once and shared across many visitors,
+     * so a silently-generated server id would be cached into the shared state and
+     * leak one guest cart/wishlist across all anonymous visitors. On the server
+     * you must pass a per-visitor `guestId` (config or `setGuestId`) yourself.
+     * @returns {string | undefined} The guest identifier, or undefined when none is available.
+     */
+    protected _getGuestId(): string | undefined;
     /**
      * Constructs the full URL path by appending the given path to the base URL.
      * @param {string} path - The path to append to the base URL.
@@ -254,6 +272,17 @@ export default abstract class SyncModules {
      * @returns {any} The instance of SyncModules for chaining.
      */
     setRefreshToken(refreshToken: string): any;
+    /**
+     * Sets the guest identifier in the state.
+     *
+     * Once set, it is sent as the `x-guest-id` header on unauthenticated requests,
+     * enabling guest cart/wishlist/activity flows. Pass an empty string to clear it
+     * (the SDK then falls back to the localStorage-backed id in the browser, or to
+     * no guest id at all on the server).
+     * @param {string} guestId - The guest identifier to set (empty string clears it).
+     * @returns {any} The instance of SyncModules for chaining.
+     */
+    setGuestId(guestId: string): any;
     /**
      * Get deviceMetadata
      *
@@ -275,7 +304,7 @@ export default abstract class SyncModules {
      * 3. Concatenates the hash and the first 12 characters of instanceId.
      *
      * **instanceId strategy:**
-     * - Browser: `_getBrowserDeviceId()` — read from localStorage, stable across sessions.
+     * - Browser: `_getPersistentBrowserId('oneentry_device_id')` — read from localStorage, stable across sessions.
      * - Node.js / no localStorage: `_nodeDeviceId` — generated at instance creation,
      * lives until the process restarts.
      *