@elmohq/sdk 0.1.2 → 0.1.3

package/src/types/shared/position.ts

@@ -0,0 +1,51 @@
+/**
+ * **Experimental — the shape may still change.**
+ *
+ * The company's position among the tracked companies the answers name, 1 being named first.
+ * Companies that aren't tracked aren't ranked. Counted over every answer in the window, unlike
+ * `visibility.current` and the share-of-voice `mentions` and `share`, which count each prompt's
+ * latest result.
+ */
+export type Position = {
+  /**
+   * Average position to one decimal; null when no answer ranks it.
+   *
+   * @minimum 1
+   */
+  average: number | null;
+};
+
+/**
+ * **Experimental — the shape may still change.**
+ *
+ * Answers that mention the company, by the mention judge's sentiment toward it. An answer that only
+ * links to the company counts in none. All zero for history the judge hasn't re-judged yet. Counted
+ * over every answer in the window, unlike `visibility.current` and the share-of-voice `mentions`
+ * and `share`, which count each prompt's latest result.
+ */
+export type SentimentSummary = {
+  /** @minimum 0 */
+  mixed: number;
+  /** @minimum 0 */
+  negative: number;
+  /**
+   * Negative answers as a fraction of those with a sentiment (the four counts). Ratio 0–1; null
+   * when there are none.
+   *
+   * @minimum 0
+   * @maximum 1
+   */
+  negativeShare: number | null;
+  /** @minimum 0 */
+  neutral: number;
+  /** @minimum 0 */
+  positive: number;
+  /**
+   * Positive answers as a fraction of those with a sentiment (the four counts). Ratio 0–1; null
+   * when there are none.
+   *
+   * @minimum 0
+   * @maximum 1
+   */
+  positiveShare: number | null;
+};

package/src/types/snapshots.ts

@@ -6,6 +6,7 @@ import type {
 } from './shared/error';
 import type { MentionsSummary } from './shared/mention-entry';
 import type { NotFoundError } from './shared/not-found-error';
+import type { Position, SentimentSummary } from './shared/position';
 import type { ValidationError } from './shared/validation-error';
 
 export type CitedURLEntry = {
@@ -33,10 +34,12 @@ export type PromptSnapshot = {
   /** End of the queried date range (YYYY-MM-DD) */
   endDate: string;
   mentions: MentionsSummary;
+  position: Position;
   /** Unique identifier for the prompt */
   promptId: string;
   /** The prompt text */
   promptValue: string;
+  sentiment: SentimentSummary;
   /** Start of the queried date range (YYYY-MM-DD) */
   startDate: string;
 };

package/dist/tools-DpxrXc33.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tools-DpxrXc33.d.mts","names":[],"sources":["../src/types/shared/error.ts","../src/types/shared/model-filter.ts","../src/types/shared/not-found-error.ts","../src/types/shared/validation-error.ts","../src/types/analytics.ts","../src/types/shared/brand-id-path.ts","../src/types/opportunities.ts","../src/types/tags.ts","../src/types/shared/conflict-error.ts","../src/types/shared/limit.ts","../src/types/shared/page.ts","../src/types/shared/pagination.ts","../src/types/brands.ts","../src/types/competitors.ts","../src/types/identity.ts","../src/types/models.ts","../src/types/organizations.ts","../src/types/runs.ts","../src/types/shared/mention-entry.ts","../src/types/snapshots.ts","../src/types/prompts.ts","../src/types/reports.ts","../src/types/tools.ts"],"mappings":";KAAY;;;;;;;;;EASV;;EAEA;;EAEA;;;KAIU,oBAAoB;KAEpB,sBAAsB;;;;;KAMtB,iBAAiB;;KAGjB,iBAAiB;;;;;;;;;KCtBjB,cAAc;;;;;;KAOd,YAAY;;KAGZ;;;;KCbA,gBAAgB;;;;KCAhB,kBAAkB;;;;;;KCUlB;;EAEV,KAAK;;EAEL,OAAO;;KAGG;EACV;;;;;;;;EAQA;;KAGU;;EAEV;EACA;;EAEA;;EAEA;;;;;;;;EAQA;;KAGU;EACV;;;;;;;;EAQA;;KAGU;;EAEV;;;;;;;;;EAoBA;;EAEA;EACA;;EAEA;;EAEA;;;;;;;EAOA;;KAGU;EACV;;EAEA,MAAM,MAAM;EACZ,OAAO;EACP;IACE;IACA;IACA;;;KAIQ;;EAEV;EAYA;EACA;;EAEA;;EAEA;EAeA;EACA;EACA;;KAGU;EACV;;EAEA,MAAM,MAAM;EACZ,OAAO;EACP;IACE;IACA;IACA;;;KAIQ;EACV;;EAEA;EACA;;KAGU;EACV;EACA;;;;;;;;EAQA;;EAEA,MAAM,MAAM;;;;;EAKZ;EACA,OAAO;EACP;EACA;EACA;;KAGU;;;;;;;EAOV;;;;;;;;EAQA;EACA,kBAAkB;EAClB,WAAW;EACX;EACA,MAAM;EACN;EACA;;KAGU;EACV;;EAEA,MAAM,MAAM;EACZ,OAAO;;KAGG;EACV;EACA;EACA;EACA;EACA;;;;;;;;EAQA;;;;;;;;KASU;EACV;EACA;;EAEA,QAAQ,MAAM;EACd,OAAO;;EAEP;;;;;;;IAOE;;IAEA,SAAS,MAAM;;IAEf,QAAQ,MAAM;;EAEhB;IACE;;IAEA;IACA;IACA;IACA;;;EAGF;;;;;;;;IAQE;IACA,QAAQ,MAAM;;;;KAKN;KAEA;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;;;;;;EAOV,OAAO;;;;;;EAMP,KAAK;;EAEL,QAAQ;;EAER,OAAO;;KAGG;;;;;;;EAOV,OAAO;;;;;;EAMP,KAAK;;EAEL,QAAQ;;EAER,OAAO;;KAGG;;;;;;;EAOV,OAAO;;;;;;EAMP,KAAK;;EAEL,QAAQ;;EAER,OAAO;;KAGG;;;;;;;EAOV,OAAO;;;;;;EAMP,KAAK;;EAEL,QAAQ;;EAER,OAAO;;KAGG;;;;;;;EAOV,OAAO;;;;;;EAMP,KAAK;;EAEL,QAAQ;;EAER,OAAO;;;;;KCxfG;;;KCOA;;EAEV;;EAEA;;KAGU;EACV;EACA;EACA;;KAGU;;;;;;EAMV;;EAEA,qBAAqB,MAAM;;EAE3B,gBAAgB,MAAM;;EAEtB;;EAEA;;EAEA,eAAe,MAAM;;;;;;;;KASX;EACV;EACA,aAAa;;EAEb;;EAEA,eAAe,MAAM;;EAErB,OAAO;;;;;EAKP;;EAEA,SAAS;;KAGC;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;;;KC1EK;;EAEV;;EAEA;;;;;;EAMA;;KAGU;EACV;;EAEA,MAAM,MAAM;;KAGF;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;;;;KC1CK,gBAAgB;;KAGhB,uBAAuB;;;;;;;;;;KCCvB;;;;;;;;;KCDA;;;KCNA;EACV;EACA;;EAEA;EACA;;;;KCQU;EACV,SAAS;EACT,WAAW;;EAEX;;;;;EAKA,SAAS;EACT;;EAEA,eAAe;;EAEf;EACA;EACA;;EAEA;EACA,WAAW;;KAGD;;;;;;;EAOV,QAAQ,MAAM;;EAEd,MAAM,MAAM;EACZ,YAAY;;KAGF;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;;;;;;EAOV,OAAO;;;;;;;;EAQP,QAAQ;;;;;;KAOE;;EAEV;;EAEA;;;;;;;EAOA,SAAS;EACT,UAAU;EACV,cAAc;IACZ,UAAU;IACV,UAAU;;IAEV;;EAEF,UAAU;;IAER;IACA,OAAO;;IAEP;;;;;;;;;;;;;EAaF;;;;;;;;KASU;;EAEV;;;;;;;EAOA,UAAU;EACV,UAAU;;;;;;EAMV;;;;KCrNU;EACV,SAAS;EACT;EACA,WAAW;EACX,SAAS;EACT;EACA;EACA,WAAW;;KAGD;;;;;;;EAOV,aAAa,MAAM;;EAEnB,MAAM,MAAM;EACZ,YAAY;;KAGF;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;EACV;;;;;;;EAOA,OAAO;;;;;;;;EAQP,QAAQ;;;KAIE;;EAEV;;EAEA;EACA,UAAU;EACV,UAAU;;;;;;KAOA;;EAEV;EACA,UAAU;EACV,UAAU;;;;KC3LA;;;;;;EAMV,UAAU;EACV,WAAW;;EAEX;;EAEA,WAAW;;EAEX;EACA,YAAY;;EAEZ;EACA;;;;;EAKA;IACE;IACA;;;EAGF,QAAQ;;KAGE;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;;;KC9CK;EACV,MAAM,MAAM;;KAGF;;EAEV;;EAEA;;EAEA;;EAEA;;KAGU;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;;;KC3BK;EACV;EACA,WAAW;EACX;EACA;EACA;;;KAIU;;EAEV;;EAEA;;EAEA,WAAW;;EAEX;;EAEA;EACA;EACA;;;;;;;;KASU;;EAEV;EACA,QAAQ;EACR;;EAEA,MAAM;EACN;IACE;IACA;IACA;;;KAIQ;EACV;;EAEA;;EAEA;;EAEA;EACA,YAAY;;;;;;EAMZ;;EAEA;;KAGU;EACV,MAAM,MAAM;EACZ,YAAY;;KAGF;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;;;;;;EAOV,OAAO;;;;;;;;EAQP,QAAQ;;;;;KC7IE;EACV;EACA;EACA;EACA,sBAAsB;EACtB,WAAW;EACX;EACA;EACA;;EAEA;;EAEA,YAAY;;EAEZ;;KAGU;;EAEV;EACA;EACA;EACA;;;KAIU,MAAM;EAChB;;;;IAIE;;EAEF,WAAW,MAAM;;KAGP;EACV,MAAM,MAAM;EACZ,YAAY;;KAGF;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;;;;;;EAOV,OAAO;;;;;;EAMP,KAAK;;EAEL,QAAQ;;;;;;;EAOR,OAAO;;;;;;;;EAQP,QAAQ;;;;;KClIE;;EAEV;;;;;EAKA;;EAEA,cAAc,MAAM;;EAEpB;;KAGU;;EAEV;;EAEA;;;;KCTU;;EAEV;;EAEA;;EAEA;;KAGU;;EAEV;EACA;;IAEE;;IAEA;;IAEA,eAAe,MAAM;;IAErB;;;EAGF;EACA,UAAU;;EAEV;;EAEA;;EAEA;;KAGU;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV;;EAEA;;;;;;;;EAQA;;;;;;;;EAQA;;;;KC3EU;;EAEV;;EAEA,WAAW;;EAEX;;EAEA;;EAEA,eAAe;;EAEf,YAAY;;EAEZ,MAAM;;EAEN,WAAW;;EAEX;;KAGU;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV;;IAEE,MAAM,MAAM;IACZ;MACE;MACA;MACA;MACA;;;;;;;;IAQF,SAAS,MAAM;;;KAIP,sBAAsB,2BAA2B;KAEjD;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;IAEH;;;KAIQ,uBAAuB,4BAA4B;KAEnD;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV;;;;;;;EAOA,OAAO;;;;;;;;;;EAUP;;EAEA;;EAEA;;EAEA;;KAGU;;EAEV;;;;;;EAMA;;EAEA,OAAO;;KAGG;;;;;;EAMV;;EAEA;;EAEA,OAAO;;EAEP,gBAAgB;;;;KCxNN;;EAEV,cAAc;;EAEd;;EAEA;;EAEA,aAAa;;EAEb,WAAW;;EAEX;;EAEA;;;;;;KAOU;EACV,UAAU;;EAEV;;EAEA;;KAGU;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV;;IAEE,MAAM,MAAM;IACZ;MACE;MACA;MACA;MACA;;;;;;;;IAQF,SAAS,MAAM;;;KAIP,sBAAsB,2BAA2B;KAEjD;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV;IACE,cAAc;IACd;IACA;IACA,WAAW;;IAEX;;IAEA;;;KAIQ,uBAAuB,4BAA4B;KAEnD;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;;;;EAKV;IACE,cAAc;IACd;IACA;IACA,aAAa;IACb,WAAW;;IAEX;;IAEA,UAAU,MAAM;IAChB;IACA;;;;;IAKA;;MAEE,cAAc;;QAEZ;;QAEA;;QAEA;;;;;;;;QAQA;;;;;;;QAOA;;;MAGF;;MAEA;;;;;;;;MAQA;;;;;MAKA;;MAEA;;;;;;;;MAQA;;;;KAKM,oBAAoB,yBAAyB;KAE7C;;;;;;;EAOV,OAAO;;;;;;;;EAQP,QAAQ;;KAGE;;;;;;EAMV;;;;;;;EAOA,eAAe;;;;;;;;EAQf;;EAEA,gBAAgB;;KAGN;;;;;;;;EAQV;;;;KC/PU;EACV,mBAAmB;EACnB,SAAS;EACT;EACA,aAAa;IACX,SAAS;IACT,SAAS;IACT;;EAEF,kBAAkB;IAChB;IACA,MAAM;;;EAGR;;KAGU;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;;;;;;EAOV;;EAEA;;;;;;;;EAQA;;;;;;;;EAQA"}