oneentry 1.0.165 → 1.0.166

package/changelog.md

@@ -1,5 +1,13 @@
 # SDK Change Log
 
+## v.1.0.166
+
+### What's Fixed
+
+- **FormData > `IFormsDataFilter.entityIdentifier` accepts a number.** The field was typed `string`, but an entity is not always addressed by a text marker: product-scoped records — reviews and ratings — are filtered by the **numeric product id**, and that is what the endpoint expects. So the one filter every storefront writes, `{ entityIdentifier: product.id, status: ['approved'] }`, did not compile: `TS2322: Type 'number' is not assignable to type 'string'`. The call worked perfectly at runtime, which made the error read as a mistake in the caller rather than in the type — the usual fix was a cast, and a cast on a field whose real contract nobody had written down. The declaration is now `string | number`, documented with the full contract: a text marker for content entities (`"blog"`), the numeric id for products (`2954`), the login for users and admins.
+
+  Only the **request** is widened. The API normalizes the value and sends it back as a string — the SDK's own fixture stores a product id as `entityIdentifier: "2954"` — so `IFormByMarkerDataEntity`, `IFormDataSearchEntity`, `IPostFormResponseData` and `IUpdateFormsData` keep `entityIdentifier: string`, and reading code needs no narrowing. Types only; no runtime change, and `_stripEmptyDates` never touched this field.
+
 ## v.1.0.165
 
 ### What's New

package/dist/forms-data/formsDataApi.d.ts

@@ -90,7 +90,7 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
           "dateFrom": "2025-01-01",
           "dateTo": ""
         }
-     * @param {string} [body.entityIdentifier] - Text identifier (marker) of the entity the records belong to. Example: "blog".
+     * @param {string | number} [body.entityIdentifier] - Identifier of the entity the records belong to: a text marker for content entities ("blog"), the **numeric id for products** (2954), the login for users and admins. Example: "blog".
      * @param {number} [body.parentId] - Identifier of the parent record, to fetch replies to one submission. Example: 10.
      * @param {string} [body.userIdentifier] - Text identifier of the sender. Example: "admin".
      * @param {FormDataStatus[]} [body.status] - Moderation statuses to keep: "sent", "moderation", "approved", "banned", "deleted". Must be an array; anything outside the set is rejected with `400 each value in status must be a valid enum value`. Example: ["approved"].

package/dist/forms-data/formsDataApi.js

@@ -197,7 +197,7 @@ class FormsDataApi extends asyncModules_1.default {
           "dateFrom": "2025-01-01",
           "dateTo": ""
         }
-     * @param {string} [body.entityIdentifier] - Text identifier (marker) of the entity the records belong to. Example: "blog".
+     * @param {string | number} [body.entityIdentifier] - Identifier of the entity the records belong to: a text marker for content entities ("blog"), the **numeric id for products** (2954), the login for users and admins. Example: "blog".
      * @param {number} [body.parentId] - Identifier of the parent record, to fetch replies to one submission. Example: 10.
      * @param {string} [body.userIdentifier] - Text identifier of the sender. Example: "admin".
      * @param {FormDataStatus[]} [body.status] - Moderation statuses to keep: "sent", "moderation", "approved", "banned", "deleted". Must be an array; anything outside the set is rejected with `400 each value in status must be a valid enum value`. Example: ["approved"].

package/dist/forms-data/formsDataInterfaces.d.ts

@@ -109,7 +109,7 @@ type FormDataStatus = 'sent' | 'moderation' | 'approved' | 'banned' | 'deleted';
 /**
  * Represents the filter body of `getFormsDataByMarker`.
  * @interface IFormsDataFilter
- * @property {string} [entityIdentifier] - Text identifier (marker) of the entity the records belong to; an empty string means "no filter". Example: "blog".
+ * @property {string | number} [entityIdentifier] - Identifier of the entity the records belong to; an empty string means "no filter". Text marker for content entities ("blog"), the **numeric id for products** (2954), the login for users and admins. Example: "blog".
  * @property {number} [parentId] - Identifier of the parent record — the way to fetch replies to one comment. Example: 10.
  * @property {string} [userIdentifier] - Text identifier of the sender; an empty string means "no filter". Example: "admin".
  * @property {FormDataStatus[]} [status] - Moderation statuses to keep. Must be an array — a bare string is rejected with `400`. An empty array means "no filter". Example: ["approved"].
@@ -123,7 +123,14 @@ type FormDataStatus = 'sent' | 'moderation' | 'approved' | 'banned' | 'deleted';
  * leaking onto a public page, from one typo the compiler used to accept.
  */
 interface IFormsDataFilter {
-    entityIdentifier?: string;
+    /**
+     * `string | number` because the entity is not always addressed by a marker:
+     * product-scoped records (reviews, ratings) are filtered by the **numeric
+     * product id**, which is what the API expects and what every storefront
+     * passes. The response normalizes it back to a string, so the read-side
+     * interfaces keep `entityIdentifier: string` — only the request is widened.
+     */
+    entityIdentifier?: string | number;
     parentId?: number;
     userIdentifier?: string;
     status?: FormDataStatus[];

package/esm/forms-data/formsDataApi.d.ts

@@ -90,7 +90,7 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
           "dateFrom": "2025-01-01",
           "dateTo": ""
         }
-     * @param {string} [body.entityIdentifier] - Text identifier (marker) of the entity the records belong to. Example: "blog".
+     * @param {string | number} [body.entityIdentifier] - Identifier of the entity the records belong to: a text marker for content entities ("blog"), the **numeric id for products** (2954), the login for users and admins. Example: "blog".
      * @param {number} [body.parentId] - Identifier of the parent record, to fetch replies to one submission. Example: 10.
      * @param {string} [body.userIdentifier] - Text identifier of the sender. Example: "admin".
      * @param {FormDataStatus[]} [body.status] - Moderation statuses to keep: "sent", "moderation", "approved", "banned", "deleted". Must be an array; anything outside the set is rejected with `400 each value in status must be a valid enum value`. Example: ["approved"].

package/esm/forms-data/formsDataApi.js

@@ -159,7 +159,7 @@ export default class FormsDataApi extends AsyncModules {
           "dateFrom": "2025-01-01",
           "dateTo": ""
         }
-     * @param {string} [body.entityIdentifier] - Text identifier (marker) of the entity the records belong to. Example: "blog".
+     * @param {string | number} [body.entityIdentifier] - Identifier of the entity the records belong to: a text marker for content entities ("blog"), the **numeric id for products** (2954), the login for users and admins. Example: "blog".
      * @param {number} [body.parentId] - Identifier of the parent record, to fetch replies to one submission. Example: 10.
      * @param {string} [body.userIdentifier] - Text identifier of the sender. Example: "admin".
      * @param {FormDataStatus[]} [body.status] - Moderation statuses to keep: "sent", "moderation", "approved", "banned", "deleted". Must be an array; anything outside the set is rejected with `400 each value in status must be a valid enum value`. Example: ["approved"].

package/esm/forms-data/formsDataInterfaces.d.ts

@@ -109,7 +109,7 @@ type FormDataStatus = 'sent' | 'moderation' | 'approved' | 'banned' | 'deleted';
 /**
  * Represents the filter body of `getFormsDataByMarker`.
  * @interface IFormsDataFilter
- * @property {string} [entityIdentifier] - Text identifier (marker) of the entity the records belong to; an empty string means "no filter". Example: "blog".
+ * @property {string | number} [entityIdentifier] - Identifier of the entity the records belong to; an empty string means "no filter". Text marker for content entities ("blog"), the **numeric id for products** (2954), the login for users and admins. Example: "blog".
  * @property {number} [parentId] - Identifier of the parent record — the way to fetch replies to one comment. Example: 10.
  * @property {string} [userIdentifier] - Text identifier of the sender; an empty string means "no filter". Example: "admin".
  * @property {FormDataStatus[]} [status] - Moderation statuses to keep. Must be an array — a bare string is rejected with `400`. An empty array means "no filter". Example: ["approved"].
@@ -123,7 +123,14 @@ type FormDataStatus = 'sent' | 'moderation' | 'approved' | 'banned' | 'deleted';
  * leaking onto a public page, from one typo the compiler used to accept.
  */
 interface IFormsDataFilter {
-    entityIdentifier?: string;
+    /**
+     * `string | number` because the entity is not always addressed by a marker:
+     * product-scoped records (reviews, ratings) are filtered by the **numeric
+     * product id**, which is what the API expects and what every storefront
+     * passes. The response normalizes it back to a string, so the read-side
+     * interfaces keep `entityIdentifier: string` — only the request is widened.
+     */
+    entityIdentifier?: string | number;
     parentId?: number;
     userIdentifier?: string;
     status?: FormDataStatus[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.165",
+  "version": "1.0.166",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "module": "esm/index.js",
@@ -48,7 +48,7 @@
   },
   "scripts": {
     "prepublishOnly": "node ../scripts/smoke-pack.js --files-only",
-    "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.165"
+    "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.166"
   },
   "sideEffects": false,
   "files": [