@likyly/sdk 0.0.0-stage → 1.1.1

package/dist/esm/types.d.ts

@@ -0,0 +1,226 @@
+/** Free-form JSON object: price, currency, orderId, category, any field of your own. Keys are stored exactly as you send them. */
+export type Properties = Record<string, unknown>;
+export interface Item {
+    /** Your own identifier - any string (`SKU-123`, a UUID, `gid://shopify/Product/123`). */
+    itemId: string;
+    title: string;
+    description?: string;
+    properties: Properties;
+}
+/** What you send to create or replace an item. Only `title` is required. */
+export interface ItemInput {
+    title: string;
+    description?: string;
+    /** `category` and `description` feed content similarity; everything else is stored as is. */
+    properties?: Properties;
+}
+export interface ItemImport extends ItemInput {
+    itemId: string;
+}
+export interface ListOptions {
+    /** Page size (1-1000, default 100). */
+    limit?: number;
+    /** Rows to skip. */
+    offset?: number;
+}
+export interface ItemList {
+    items: Item[];
+    /** Total number of items in the catalog (`X-Total-Count`), when the API reported it. */
+    total?: number;
+    /** The page size you asked for (undefined = the API's default). */
+    limit?: number;
+    offset: number;
+}
+export interface User {
+    userId: string;
+    properties: Properties;
+}
+export interface UserInput {
+    /** country, segment, language, ... - whatever describes your users. */
+    properties?: Properties;
+}
+export interface UserImport extends UserInput {
+    userId: string;
+}
+export interface UserList {
+    users: User[];
+    total?: number;
+    limit?: number;
+    offset: number;
+}
+/** Result of a batch call. A failing entry is reported in `errors`, it does not throw. */
+export interface BatchResult {
+    received: number;
+    succeeded: number;
+    failed: number;
+    errors: {
+        index: number;
+        id?: string;
+        message: string;
+    }[];
+}
+/**
+ * An interaction. `itemId` and at least one of `userId` / `sessionId` are required; sending both
+ * ties an anonymous session to the user.
+ */
+export interface EventInput {
+    itemId: string;
+    userId?: string;
+    /** Anonymous visitor / browsing session - no login needed. */
+    sessionId?: string;
+    /** The `recommendationId` of the recommendation that surfaced this item - enables attribution. */
+    recommendationId?: string;
+    /** Free-form label of where this happened: `homepage`, `product_page`, `cart`, ... */
+    placement?: string;
+    quantity?: number;
+    /** ISO 8601 string or Date. Defaults to the server's time. */
+    occurredAt?: string | Date;
+    properties?: Properties;
+    /**
+     * Idempotency key, unique per account: replaying an event with the same `eventId` records nothing
+     * and returns `duplicate: true`. Set it on purchases - it makes retries safe.
+     */
+    eventId?: string;
+}
+/** An event of any type, for `events.trackMany`. `type` is an open string (`view`, `favorite`, ...). */
+export interface TypedEventInput extends EventInput {
+    type: string;
+}
+export interface EventResult {
+    message: string;
+    eventId?: string;
+    /** True if this `eventId` was already recorded - nothing was written. */
+    duplicate: boolean;
+}
+export interface EventBatchResult {
+    received: number;
+    accepted: number;
+    /** Events skipped because their `eventId` was already recorded. */
+    duplicates: number;
+}
+/** Call right after login/signup, once you know `userId`, for the `sessionId` the visitor was
+ * anonymous under - see `events.identify`. */
+export interface IdentifyInput {
+    userId: string;
+    sessionId: string;
+}
+export interface IdentifyResult {
+    /** How many of this session's past interactions now belong to `userId`. */
+    linkedInteractions: number;
+}
+/** Send whatever you know: LIKYLY chooses the best strategy. All fields are optional. */
+export interface RecommendationRequest {
+    userId?: string;
+    sessionId?: string;
+    /** The item being looked at (e.g. the product page). */
+    itemId?: string;
+    /** Recently viewed items, oldest first. */
+    viewedItemIds?: string[];
+    /** Free-form label of where the recommendations will be shown. */
+    placement?: string;
+    /** How many items to return (1-100, default 10). */
+    limit?: number;
+    /** Diagnostic detail in `explanation`. Secret key only. */
+    debug?: boolean;
+}
+export interface SimilarUser {
+    userId: string;
+    sharedItemIds: string[];
+}
+export interface Explanation {
+    reason: string;
+    contentSimilarity?: number;
+    semanticSimilarity?: number;
+    popularityScore?: number;
+    interactionCount?: number;
+    interactionLabel?: string;
+    collaborativeScore?: number;
+    sourceItemIds?: string[];
+    /** Only with `debug` and a secret key. */
+    similarUsers?: SimilarUser[];
+}
+export interface RecommendedItem {
+    itemId: string;
+    score?: number;
+    title?: string;
+    description?: string;
+    properties: Properties;
+    explanation?: Explanation;
+}
+export interface RecommendationResponse {
+    /** Send it back on the impression / click / add_to_cart / purchase events for these items. */
+    recommendationId: string;
+    /** What LIKYLY used: `hybrid`, `content`, `collaborative`, `session` or `popular`. */
+    strategy: string;
+    placement?: string;
+    items: RecommendedItem[];
+}
+interface AdvancedBase {
+    placement?: string;
+    /** Attach the recommendation to an anonymous session, for attribution. */
+    sessionId?: string;
+    /** How many items to return (default 10). */
+    limit?: number;
+}
+export interface PopularOptions extends AdvancedBase {
+}
+export interface SimilarOptions extends AdvancedBase {
+    itemId: string;
+}
+export interface CollaborativeOptions extends AdvancedBase {
+    userId: string;
+}
+export interface HybridOptions extends AdvancedBase {
+    userId: string;
+    itemId: string;
+    /** Weight of the collaborative signal against content similarity: 0 = pure content, 1 = pure collaborative (default 0.5). */
+    alpha?: number;
+}
+/** Give `viewedItemIds` (an explicit list, oldest first) OR `userId` (LIKYLY's own history of that user's views). */
+export interface SessionOptions extends AdvancedBase {
+    viewedItemIds?: string[];
+    userId?: string;
+}
+/**
+ * What you know about the moment - every field optional unless the placement's own
+ * `signals.required` names it (see `likyly.placements` and GET .../requirements).
+ */
+export interface PlacementContext {
+    /** The product/article/listing currently being viewed. */
+    itemId?: string;
+    categoryId?: string;
+    collectionId?: string;
+    /** Identified visitor. */
+    userId?: string;
+    /** Stable anonymous visitor id - used like `sessionId` when `sessionId` is omitted. See `LikylySession`. */
+    anonymousId?: string;
+    /** Anonymous browsing session. */
+    sessionId?: string;
+    cartItemIds?: string[];
+    locale?: string;
+    customContext?: Record<string, unknown>;
+}
+export interface PlacementRecommendOptions {
+    /** The placement's slug, e.g. "pdp-related". */
+    placement: string;
+    context?: PlacementContext;
+    /** Overrides the placement's own configured limit for this call. */
+    limit?: number;
+}
+export interface PlacementRecommendResponse {
+    /** Send it back on the impression / click / add_to_cart / purchase events for these items. */
+    recommendationId: string;
+    placement: string;
+    /** What the placement actually used: `hybrid`, `content`, `collaborative`, `session` or `popular`. */
+    strategyUsed: string;
+    items: RecommendedItem[];
+}
+export interface RequestOptions {
+    /** Cancel the call. */
+    signal?: AbortSignal;
+    /** Overrides the client's timeout (milliseconds) for this call. */
+    timeout?: number;
+    /** Overrides the client's retry count for this call. */
+    maxRetries?: number;
+}
+export {};

package/dist/esm/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/version.d.ts

@@ -0,0 +1,3 @@
+export declare const SDK_VERSION = "1.1.1";
+export declare const DEFAULT_BASE_URL = "https://api.likyly.com";
+export declare const USER_AGENT = "likyly-typescript/1.1.1";

package/dist/esm/version.js

@@ -0,0 +1,3 @@
+export const SDK_VERSION = "1.1.1";
+export const DEFAULT_BASE_URL = "https://api.likyly.com";
+export const USER_AGENT = `likyly-typescript/${SDK_VERSION}`;

package/package.json

@@ -1,6 +1,62 @@
 {
   "name": "@likyly/sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.1.1",
+  "description": "Product recommendations for your site (\"You may also like\", \"Recommended for you\"), learned from what your visitors do. Official LIKYLY client for JavaScript and TypeScript: browser, Node.js, edge.",
+  "keywords": [
+    "likyly",
+    "recommendations",
+    "product recommendations",
+    "recommender",
+    "personalization",
+    "ecommerce",
+    "you may also like",
+    "typescript"
+  ],
+  "homepage": "https://www.likyly.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Likyly/likyly-recsys.git",
+    "directory": "sdk/js"
+  },
+  "bugs": {
+    "url": "https://github.com/Likyly/likyly-recsys/issues"
+  },
+  "author": "LIKYLY (https://www.likyly.com)",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/esm",
+    "dist/cjs",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json && node scripts/mark-cjs.mjs",
+    "typecheck": "tsc -p tsconfig.test.json --noEmit",
+    "test": "rm -rf dist/test && tsc -p tsconfig.test.json && node --test \"dist/test/test/*.test.js\"",
+    "example": "npm run build && node examples/quickstart.mjs"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.5.4"
+  }
+}