@lana-commerce/core 11.0.0

package/CHANGELOG.md

@@ -0,0 +1,531 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project adheres to [Semantic Versioning][semantic versioning].
+
+## [Unreleased]
+
+---
+
+## [Released]
+
+## 11.0.0 (2024-05-14)
+
+### Major Changes
+
+- Add more Mutator methods, some public methods were changed also (modify/delete actions no longer return an id).
+- There was a backwards incompatible API change. JSON types are updated accordingly.
+- Remove unused files:
+  - "auth"
+  - "preact/translate"
+  - "react/translate"
+  - "react/translateStatic"
+  - "translate"
+- Add custom items support into "lineItemPrice" module functions.
+- Add custom items support into "cart" and "customer" modules.
+- Update dependencies (includes major version updates).
+- The whole package is re-packaged so that both CommonJS and ESM environments are supported. This also changes typescript
+  codegen targets. CommonJS version targets ES2015, ESM targets ESNext.
+- Remove "twitter" from oauth helpers.
+- Rebranding to Lana.
+
+### Minor Changes
+
+- Add "loadJWT" helper function.
+- Add "persist" config option to "cart"/"customer"/"search" modules. Allows you to keep the state in localStorage/sessionStorage and sync between browser tabs. Useful for multi-page applications.
+- Add "load_or" init kind to "cart" module. This is to opt-in for loading data from persistent storage (requires "persist" config option to be present). Other modules ("customer"/"search") will always use "persist" config option on init if provided. This is to avoid user confusion. As in "cart" we explicitly ask for things during init, it would be unwise to override this behaviour.
+- Mutator can now be initialized with options, currently there is a single option that controls API call parallelism.
+- Add a notion of sales channel id in graphql API and json API.
+- Add sales channel id propagation for remote auth.
+- Add OTP via email login functionality to "customer" module.
+- Add SixDigitInput component for react/preact.
+- New system error type "fetch_not_defined". For cases when "fetch" is not defined and requires a polyfill. A common error for older node runtimes.
+- Add tips-related field to Shop fragment.
+- Add support for tips (ui.js script loader).
+- Add "filterFunc" lib.
+
+---
+
+## 10.0.0 (2023-06-13)
+
+### Major Changes
+
+- Move/reorganize effector modules and related code to "modules" dir.
+- Slightly change "cachedLoader" interface.
+- Fix nullability in JSON API types.
+- Breaking API change: File's "size" field is now a string. GraphQL is limited to int32, but we have to support large files.
+- "customer" module no longer loads a page on "idle" init kind. Previous behaviour is preserved in newly added "default" init kind. However, it is recommended to load something only when user displays the UI.
+
+### Minor Changes
+
+- Add websocket-based file upload code into "mutator".
+- Add "modules/imageDialog".
+- Add "modules/popupMessage".
+- Add "modules/recentlyVisitedProducts".
+- Add "modules/advancedSearch".
+- Add a bunch of module helpers ("modules/helpers").
+- Add "hierarchicalSearchOption".
+- Add "getOAuth2Hook".
+- Add "refreshTimeout".
+- Add "asyncModuleWrapper".
+- Add "productFiltering".
+- Add "productSorting".
+- Add "effector/debounced".
+- Add "configLoader".
+- Add "dataLoader".
+- Add "promiseAll".
+- Add "timeIt".
+- Add "Hooks" type to "canonicalVariantURL".
+- Expose "StringField" and "BooleanField" in "effector/form" (reduces .d.ts size).
+- Expose "ValidatorConst" and "ValidatorTupleConsts" in "effector/validator" (reduces .d.ts size).
+- Add "cancel order" functionality to "customer" module.
+- Expose "canceled_at" on brief order in "customer" module.
+- Add "rfc3339Normalize".
+- GraphQL client in "request" will use APQs now.
+
+### Patch Changes
+
+- Tweak how stores are observed internally: store.watch() => store.updates.watch(). This was assumed. On stores watch() is called on init as well.
+- Customer info loading process no longer contributes to customer module's "somethingIsPending" store.
+- Create return page (customer module) ignores some errors on init now, this helps with the case when no return policies were found.
+
+---
+
+## 9.0.0 (2023-01-27)
+
+### Major Changes
+
+- A slight change in request API to enable broader usage.
+- Slightly change "uploadFile" interface.
+- Adapt code for backwards incompatible storefront API changes.
+
+### Minor Changes
+
+- Add type-safe JSON API wrappers: "json/commerce" and "json/storefront".
+- Add JSON API (commerce API) based scripting helper API: "json/mutator".
+- Add PromiseLimiter ("promiseLimit").
+- Add "trace".
+- Add "traverse".
+- Add "uploadFileGeneric".
+- Add "iterAllItems", kind of like "fetchAllItems", but as async iterator. Also add these for JSON API.
+
+---
+
+## 8.4.0 (2022-11-28)
+
+### Minor Changes
+
+- Add "commerce" flag to GraphQLOpts. Useful if you want to use "request" lib against default commerce API endpoint.
+
+---
+
+## 8.3.0 (2022-11-25)
+
+### Minor Changes
+
+- Add "error" and "error_count" fields to subscription graphql fragment.
+
+---
+
+## 8.2.0 (2022-11-24)
+
+### Minor Changes
+
+- Bump deps and regenerate graphql types. Adds "too_many_subscriptions" order line item error.
+
+---
+
+## 8.1.0 (2022-11-24)
+
+### Minor Changes
+
+- Bump deps and regenerate graphql types. Adds "pending_payment" state to subscriptions.
+
+---
+
+## 8.0.0 (2022-11-21)
+
+### Major Changes
+
+- Fix "customer" module (backwards incompatible backend API change).
+
+### Minor Changes
+
+- Add support for subscription-based pricing to variantPrice/lineItemPrice.
+- Add basic "subscriptions" and "subscription" page graphs to customer model.
+- Make cart line items aware of subscription plan index.
+- Add "shopSubscriptionURL" to "shopLinks".
+- Add more fields to SearchProduct to keep it compatible with cart.
+
+### Patch Changes
+
+- A fix in internal customer model logic. It should not be allowed to store pages with parameters as "lastAuthPage". This breaks the logic if you switch between different customers which do not have items with the same id obviously.
+- Fix "formatToJSX". There were some problematic edge cases when nested JSX elements were used in T-strings.
+
+---
+
+## 7.2.2 (2022-10-10)
+
+### Patch Changes
+
+- Fix a bug in "isoStripTrailingZeros".
+
+---
+
+## 7.2.1 (2022-10-05)
+
+### Patch Changes
+
+- Fix typo in "shopBuyURL". Add a test for it.
+
+---
+
+## 7.2.0 (2022-10-05)
+
+### Minor Changes
+
+- Add "shopBuyURL" helper to "shopLinks" module.
+
+---
+
+## 7.1.0 (2022-10-04)
+
+### Minor Changes
+
+- Codegen. Adds new invalid input error kind: "invalid_url_id".
+
+---
+
+## 7.0.0 (2022-10-04)
+
+### Major Changes
+
+- Properly handle 429 errors. Make "backoffRetry" function private.
+- Product model now requires "count" to be returned from review images page. This is backwards incompatible. But if you
+  use default product graphql queries, nothing changes.
+- Customer module interface was slightly modified, config now requires shopCurrency and optional currency store. This is
+  used to initialize internal state of the store credit page graph and fetch the customer balance history. Thus
+  this change also adds customer balance history to store credit page graph.
+- "setLocale" and "getLocale" from framework specific modules were moved to a common "translateLocale" module.
+- T-string formatting library now supports nested replacement strings, technically I had to change the JSXConfig
+  interface slightly, so it's a breaking change. Also return value of the T formatting functions has been updated.
+  When T formatting function contains a JSX.Element argument it may return JSX.Element or string. The "or string" is
+  the clarification. It may happen if JSX.Element argument is unused.
+- Cart model now requires "fields" and "field_set" on line items. This change also integrates product field sets
+  functionality into the cart.
+
+### Minor Changes
+
+- RootCloseWrapper now accepts optional ignoreBelowWidth parameter. It can be used to disable root close wrapper in
+  a desktop vs. mobile scenario. E.g.: modal dialog on desktop, normal page content on mobile.
+- RootCloseWrapper now accepts optional ignoreAboveWidth parameter. Same use case as ignoreBelowWidth, but reversed.
+- Extend CustomerOrderBrief with line items info. Some UIs might want to show the items of an order in the list. Sadly
+  our customer data model doesn't allow you to override graphql queries, because there are quite a lot of them.
+- Expose "redeemedGiftCard" event for credit store page.
+- Product effector graph now exposes "signInRequired" event, which is fired if user clicked something that requires
+  JWT, but JWT is missing.
+- Expose a very specific "wrapSignInRequired" helper for effector.
+- Add "average_score" field to Product in default search model graphql config.
+- Add "review_count" field to Product in default search model graphql config.
+- Add "splitIntoNamed" and "nodesToHTML" helpers to slate module.
+- Add "isEmpty" helper to slate module.
+- Add new "tailSplit" module.
+- Add "addFavoriteEx" event to customer model. Allows you to subscribe to product notifications right away.
+- Add "inventoryNotification" and "priceNotification" to CustomerInfo.
+- Add new "react/translateLocalStatic" module. This is the latest T-string system iteration. Leaning towards
+  gettext-like approach.
+- Add new "preact/translateLocalStatic" module. A version for preact.
+- Add returns related pages to customer model.
+- Add "return_mode" field to product in CartVariant.
+- Extend addresses graph in customer model so that addresses are editable (showFormFor event) and one can switch
+  a default address (makeDefault event). This also adds "addressEditIndex" store (-1 when creating new address).
+- Add "invoiceFormat" helper module to simplify invoice formatting.
+- Expose "survey_answers" in product model. Read-only for now.
+- Add "discount_preview" support to lineItemPrice and to cart's graphql.
+- Add "promotionClicked" event wrapper to analytics lib.
+- Add "wishlistAdded" event wrapper to analytics lib.
+- Add "wishlistRemoved" event wrapper to analytics lib.
+- Add "storage" parameter to file uploading lib. Storefront API now allows uploading private files (for product field sets).
+
+### Patch Changes
+
+- Add tests for "convertImageURL" and a minor code improvement in that function.
+- Update graphql queries due to API rename (Category -> StorefrontCategory).
+- Remove an exported interface from aggregateOptions.ts that was never meant to be exported.
+- Don't record "reset_password" in lastAuthPage.
+- Use "tailSplit" instead of ".split()" in "formatCurrency".
+- Properly reload product model on locale changes.
+- Silence possible jwtDecode exception in getCustomerInfoFx.
+
+---
+
+## 6.0.0 (2022-04-20)
+
+### Major Changes
+
+- Add tiered pricing support for variantPrice helpers.
+- Update "script" module to reflect changes in @trunkery/ui library.
+- Update bundled default GraphQL definitions.
+
+### Minor Changes
+
+- Add "typedLocalStorage" helper module.
+- Add "shopLinks" helper module.
+- Add "shopDomain" helper module.
+- Add "popupConnectQueue" helper module.
+- Add "percentageOff" helper module.
+- Add "orderShippingAddress" helper module.
+- Add "oauthState" helper module.
+- Add "lineItemPrice" helper module.
+- Add "isoStripTrailingZeros" helper module.
+- Add "generateRandomToken" helper module.
+- Add "customerOauth2" helper module.
+- Add "detailed" mode to "prettyPrintRequestResponseError" function.
+- Add "details" component to request response, it can be used to form a more detailed error message.
+- Fixes and improvements to customer module. Add oauth2 flow support. Expose "customerInfo" store and "message" event.
+
+---
+
+## 5.0.2 (2021-09-21)
+
+### Patch Changes
+
+- Fix broken GraphQL operations.
+
+---
+
+## 5.0.1 (2021-09-21)
+
+### Patch Changes
+
+- Bump deps, regenerate all graphql operations/fragments.
+
+---
+
+## 5.0.0 (2021-09-09)
+
+### Major Changes
+
+- Remove "children" field from categories. The API has changed. Categories API no longer has recursive types in it.
+
+---
+
+## 4.1.2 (2021-09-02)
+
+### Patch Changes
+
+- GraphQL type compatibility fixes.
+
+---
+
+## 4.1.1 (2021-09-02)
+
+### Patch Changes
+
+- On customer signup the "timezone_hint" is set to automatically inferred timezone name (via Intl API).
+
+---
+
+## 4.1.0 (2021-09-02)
+
+### Minor Changes
+
+- Add "getTimezone()" utility function. Uses Intl API to get the current timezone.
+
+---
+
+## 4.0.0 (2021-07-27)
+
+### Major Changes
+
+- Tweak "status" field of InventoryStatus in "variantInventory" module. It has the following values now:
+  - `sold_out`: when qty is unknown or <= 0 and inventory_policy is "deny".
+  - `available`: when qty is unknown or <= 0 and inventory_policy is "continue".
+  - `low_stock`: when qty is > 0 and <= low_stock_level.
+  - `in_stock`: when qty is > 0 and > low_stock_level.
+
+---
+
+## 3.5.0 (2021-07-26)
+
+### Minor Changes
+
+- Expand "CartVariant" definition. Include more fields (per location inventory data).
+
+---
+
+## 3.4.0 (2021-07-21)
+
+### Minor Changes
+
+- New SystemErrorType: "timeout". Self explanatory.
+- Request API should now properly recognize internal 500 errors and trigger retry logic on those.
+- Request API should now properly recognize timeout errors and report them as such (new SystemErrorType).
+- Request API pauses between retries are reduced. Also a bit of jitter is added to pauses.
+
+---
+
+## 3.3.0 (2021-07-21)
+
+### Minor Changes
+
+- Expand "CartVariant" definition. Include more fields.
+
+---
+
+## 3.2.0 (2021-07-21)
+
+### Minor Changes
+
+- In product module fetch more data for "ReviewQuestionProduct". Making it compatible with "clay" idea of product.
+
+---
+
+## 3.1.0 (2021-07-16)
+
+### Minor Changes
+
+- Accept "null" as "canonicalVariantURL" to "productSEO()". In this case canonical page urls won't be formed.
+
+---
+
+## 3.0.0 (2021-07-15)
+
+### Major Changes
+
+- Peer dependencies "react" and "react-dom" specify version 16 or 17 now (previously it was only 17).
+- Change Environment definition in "analyticsProductData" module. It includes currency info now.
+- Change "analyticsProductData" interface. It no longer accepts "currency" via argument (moved to environment).
+- Cart/customer/product/search modules require "jwt" and "locale" stores on init now. Stores are integrated into logic and module reacts to value changes in those stores appropriately.
+- Avoid resetting reviews/questions state in product module on sortBy/sortDesc events.
+- Update "script" module to reflect changes in @trunkery/ui library.
+- Extend types accepted as an argument to formatToJSX.
+- Make "productSEO" module interface currency aware.
+- Make "react/translate" module context-based as preact counterpart.
+- Make "toMajor" slightly more generic (less strict requirements for input data).
+- Make "variantImage" aware of "linked_media_files".
+- Make "variantImageURL" aware of "linked_media_files".
+- Make "variantPriceInfo" aware of currencies. It performs currency conversion now when necessary.
+- Cart module no longer provides "overrideLocaleAndReload" event.
+- Customer module no longer provides "jwt" store and "setLocale" event.
+- Product module no longer provides "jwt" store and "configWithJWT" store.
+- Remove "image_fallback" from file fragments in default graphql.
+- Remove "name" from "rdsToInitialScores" module. Review dimension name can be translated to other languages, hence it has no place in logic-oriented module.
+
+### Minor Changes
+
+- New "aggregateOptions" helper module. Contains utility functions for working with product variants based on options.
+- Add "page()" function to "analytics" module.
+- Add "cachedLoader" helper module.
+- Add "categorySEO" helper module.
+- Add "currency" store and "setCurrency" event to cart module.
+- Add "effector/hideOnChangeAfterDelay" module. It's similar to "effector/clearOnChangeAfterDelay", but with a slightly different interface.
+- Add more fields to variant fragments in default graphql. Include "linked_media_files", some inventory-related fields and currency prices.
+- Add currency exchange rate related fields to currency fragments in default graphql.
+- Add "preact/transition" module. A port of "preact-transitioning" to typescript.
+- Add "useT" hook for preact and react. It allows you to get the raw string value (instead of a JSX element).
+- Add "react/translateStatic" module. It behaves as old "react/translate" module (based on global state).
+- Add "react/useAsyncCachedValue" module.
+- Add "toMinor" module. It's a "toMajor" counterpart.
+- Add "variantInventory" helper module. It summarizes the state of variant inventory.
+
+### Patch Changes
+
+- Fix typo in file name: clearOnChangeAfterChange.ts -> clearOnChangeAfterDelay.ts.
+
+---
+
+## 2.4.0 (2021-05-21)
+
+### Minor Changes
+
+- Add "getSessionID()" function. Which returns the current session id (analytics).
+- Request API will use the result of getSessionID() if no sessionID provided.
+
+---
+
+## 2.3.0 (2021-05-21)
+
+### Minor Changes
+
+- Product fragment now include "handle". It might be required for URL building.
+
+---
+
+## 2.2.0 (2021-05-21)
+
+### Minor Changes
+
+- Add analytics helper functions.
+- Analytics anonymous id is now implicitly propagated when submitting jwt to remote auth.
+
+---
+
+## 2.1.2 (2021-05-20)
+
+### Patch Changes
+
+- Inline scripts cannot be deferred, use DOMContentLoaded instead.
+
+---
+
+## 2.1.1 (2021-05-20)
+
+### Patch Changes
+
+- Use proper CDN URL when fetching last analytics lib version.
+
+---
+
+## 2.1.0 (2021-05-20)
+
+### Minor Changes
+
+- Add "script" library. It's a helper lib that generates &lt;script&gt; and &lt;style&gt; tags for you. Supports analytics and trunkery ui.
+
+---
+
+## 2.0.0 (2021-05-18)
+
+### Major Changes
+
+- In "search" module replace "result" field in "Search&lt;Product&gt;" with a different type. It communicates explicitly the outcome of the search request: did it run? did it resulted in an error? did it succeed with some result (or none)?
+
+---
+
+## 1.1.0 (2021-05-14)
+
+### Minor Changes
+
+- Export "PopperBinderParams" and "Placement" from popperBinder.
+
+---
+
+## 1.0.3 (2021-05-11)
+
+### Patch Changes
+
+- Add CHANGELOG.
+
+---
+
+## 1.0.2 (2021-05-11)
+
+### Patch Changes
+
+- Fix vendored popper.js files.
+
+---
+
+## 1.0.0 (2021-05-10)
+
+### Major Changes
+
+- Initial release.
+
+---
+
+<!-- Links -->
+
+[semantic versioning]: https://semver.org/

package/cjs/actionLock.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionLock = void 0;
+const tslib_1 = require("tslib");
+class ActionLock {
+    constructor(name) {
+        this.locked = false;
+        this.name = "<anonymous action lock>";
+        if (name)
+            this.name = name;
+    }
+    do(f) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (this.locked) {
+                console.warn(`ignoring action while another is still in progress (${this.name})`);
+                return;
+            }
+            this.locked = true;
+            yield f();
+            this.locked = false;
+        });
+    }
+    proxy(f) {
+        return ((...args) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return this.do(() => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                yield f(...args);
+            }));
+        }));
+    }
+}
+exports.ActionLock = ActionLock;

package/cjs/addEmptyListItem.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addEmptyListItem = void 0;
+function addEmptyListItem(list) {
+    return [{ value: "", label: "" }, ...list];
+}
+exports.addEmptyListItem = addEmptyListItem;