@deallony/shared 1.2.69 → 1.2.72

package/README.md

@@ -1,43 +1,64 @@
-# @deallony/shared
-
-Shared TypeScript types, DTOs, Zod schemas, and utilities for Deallony projects.
-
-## One-command releases
-
-Run from a clean, synchronized `main` branch with push access to `origin/main`.
-
-| Command | Action |
-| --- | --- |
-| `npm run deploy` | Bump patch, build, publish to npm, commit/tag/push GitLab |
-| `npm run deploy:minor` | npm + GitLab minor release |
-| `npm run deploy:major` | npm + GitLab major release |
-| `npm run deploy:dry-run` | Preview version and inspect current package, no mutation |
-| `npm run deploy:git` | Bump patch, build, commit/tag/push GitLab without npm publish |
-| `npm run deploy:git:minor` | GitLab-only minor release |
-| `npm run deploy:git:major` | GitLab-only major release |
-| `npm run deploy:git:dry-run` | Preview GitLab-only release |
-
-Version increments follow semantic versioning; `1.2.99` becomes `1.2.100`.
-
-### Automatic npm login
-
-`npm run deploy` first checks `npm whoami`. If npm returns E401 or ENEEDAUTH,
-the script runs `npm login --registry=https://registry.npmjs.org/ --auth-type=web` and
-opens the browser sign-in flow. After you finish logging in, it rechecks your
-identity and continues the same release. Network failures and canceled logins
-stop the release before modifying the package version. `deploy:git` never logs
-into npm.
-
-### npm authentication
-
-Run `npm login --registry=https://registry.npmjs.org/` and ensure your account has
-publishing permission for the public scoped package `@deallony/shared`.
-Complete any npm 2FA prompts when required. Never commit npm tokens.
-
-### Failure recovery
-
-If publishing fails, inspect and restore generated local changes before retrying.
-If npm publication succeeds but Git push/commit fails, **do not republish that version**.
-Resolve the Git issue and push the existing release commit and `vX.Y.Z` tag.
-
-Merge this feature branch first; merging does not trigger publication automatically.
+# @deallony/shared
+
+Shared TypeScript types, DTOs, Zod schemas, and utilities for Deallony projects.
+
+## One-command releases
+
+Run from a clean, synchronized `main` branch with push access to `origin/main`.
+
+| Command | Action |
+| --- | --- |
+| `npm run deploy` | Bump patch, build, publish to npm, commit/tag/push GitLab |
+| `npm run deploy:minor` | npm + GitLab minor release |
+| `npm run deploy:major` | npm + GitLab major release |
+| `npm run deploy:dry-run` | Preview version and inspect current package, no mutation |
+| `npm run deploy:git` | Bump patch, build, commit/tag/push GitLab without npm publish |
+| `npm run deploy:git:minor` | GitLab-only minor release |
+| `npm run deploy:git:major` | GitLab-only major release |
+| `npm run deploy:git:dry-run` | Preview GitLab-only release |
+
+Version increments follow semantic versioning; `1.2.99` becomes `1.2.100`.
+
+### Automatic npm login
+
+`npm run deploy` first checks `npm whoami`. If npm returns E401 or ENEEDAUTH,
+the script runs `npm login --registry=https://registry.npmjs.org/ --auth-type=web` and
+opens the browser sign-in flow. After you finish logging in, it rechecks your
+identity and continues the same release. Network failures and canceled logins
+stop the release before modifying the package version. `deploy:git` never logs
+into npm.
+
+### npm authentication
+
+Run `npm login --registry=https://registry.npmjs.org/` and ensure your account has
+publishing permission for the public scoped package `@deallony/shared`.
+Complete any npm 2FA prompts when required. Never commit npm tokens.
+
+### Publish without browser approval
+
+A normal `npm login` session still makes `npm publish` open the browser for 2FA
+on every release. A granular token with "bypass 2FA" removes that step:
+
+1. On npmjs.com open your avatar > **Access Tokens** > **Generate New Token** >
+   **Granular Access Token**.
+2. Name it `deallony-shared-publish`, pick an expiration (npm caps write tokens,
+   so note the date to renew), and tick **Bypass two-factor authentication (2FA)**.
+3. Under **Packages and scopes** choose **Read and write**, **Only select
+   packages and scopes**, and select `@deallony/shared`. Leave organizations at
+   no access. Generate and copy the token.
+4. Run `notepad $HOME\.npmrc` (PowerShell) and set this line, replacing any
+   existing `//registry.npmjs.org/:_authToken=` line:
+   `//registry.npmjs.org/:_authToken=<paste token>`. Save. Editing the file
+   keeps the token out of shell history; never paste it into a repo `.npmrc`.
+5. Check with `npm whoami`, then `npm run deploy:dry-run`.
+
+When the token expires, `npm whoami` fails and the script falls back to browser
+login; generate a new token and repeat step 4.
+
+### Failure recovery
+
+If publishing fails, inspect and restore generated local changes before retrying.
+If npm publication succeeds but Git push/commit fails, **do not republish that version**.
+Resolve the Git issue and push the existing release commit and `vX.Y.Z` tag.
+
+Merge this feature branch first; merging does not trigger publication automatically.

package/dist/cjs/constants/routes/app.d.ts

@@ -6,6 +6,30 @@ export declare const APP_ROUTES: {
             pathname: string;
         };
     };
+    readonly notifications: {
+        /** The notification centre (favorites updates) */
+        readonly list: () => {
+            pathname: string;
+        };
+        readonly settings: () => {
+            pathname: string;
+        };
+    };
+    readonly favorites: {
+        readonly compare: (ad_ids: (number | string)[]) => {
+            pathname: string;
+            params: {
+                ids: string;
+            };
+        };
+        /** A favorites list someone shared */
+        readonly sharedList: (token: string) => {
+            pathname: string;
+            params: {
+                token: string;
+            };
+        };
+    };
     readonly categories: {
         readonly all: (params: {
             type: SubjectTypeValue;

package/dist/cjs/constants/routes/app.js

@@ -5,6 +5,19 @@ exports.APP_ROUTES = {
     main: {
         home: () => ({ pathname: "/(tabs)" }),
     },
+    notifications: {
+        /** The notification centre (favorites updates) */
+        list: () => ({ pathname: "/notifications" }),
+        settings: () => ({ pathname: "/notifications/settings" }),
+    },
+    favorites: {
+        compare: (ad_ids) => ({
+            pathname: "/favorites/compare",
+            params: { ids: ad_ids.join(",") },
+        }),
+        /** A favorites list someone shared */
+        sharedList: (token) => ({ pathname: "/favorites/list/[token]", params: { token } }),
+    },
     categories: {
         all: (params) => ({
             pathname: "/category/all-category",

package/dist/cjs/types/ad/Ad.d.ts

@@ -68,8 +68,11 @@ export type IAd = {
     created_at?: string | Date;
     updated_at?: string | Date;
     expires_at?: string | Date | null;
+    deleted_at?: string | Date | null;
+    /** My ads: how many users saved this ad */
+    favorites_count?: number;
 };
-export type SaveAdDto = Partial<Omit<IAd, "created_at" | "updated_at" | "views" | "user" | "promotions" | "company">> & {
+export type SaveAdDto = Partial<Omit<IAd, "created_at" | "updated_at" | "views" | "user" | "promotions" | "company" | "deleted_at" | "favorites_count">> & {
     id?: number;
     latitude?: number;
     longitude?: number;

package/dist/cjs/types/communication/Chat.d.ts

@@ -9,12 +9,14 @@ export type IChatRoom = {
         name: string;
         phone: string;
         email?: string;
+        avatar_url?: string | null;
     };
     provider: {
         id: number;
         name: string;
         phone: string;
         email?: string;
+        avatar_url?: string | null;
     };
     ad?: {
         id: number;
@@ -23,6 +25,8 @@ export type IChatRoom = {
     chats?: IChatMessage[];
     lastMessage?: string;
     lastMessageAt?: Date;
+    /** Messages in this room the current user has not seen yet. */
+    unread_count?: number;
 };
 export type IChatMessage = {
     id: number;
@@ -30,14 +34,27 @@ export type IChatMessage = {
     message_type: MessageTypeEnum;
     payload?: Record<string, any> | null;
     created_at: Date;
+    delivered_at?: Date | string | null;
+    seen_at?: Date | string | null;
     chat_room_id: number;
     sender_id: number;
     sender: {
         id: number;
         name: string;
         phone: string;
+        avatar_url?: string | null;
     };
 };
+/** Live `inboxMessage` socket event sent to the receiver of a new message. */
+export type IChatInboxMessage = {
+    chat_room_id: number;
+    message_id: number;
+    message: string;
+    message_type: MessageTypeEnum;
+    payload?: Record<string, any> | null;
+    sender_id: number;
+    created_at: Date | string;
+};
 export declare enum MessageTypeEnum {
     TEXT = 1,
     PRICE_OFFER = 2,

package/dist/cjs/types/communication/Notification.d.ts

@@ -0,0 +1,57 @@
+import { IAd } from "../ad/Ad";
+/** Notifications kept in the user's notification centre. Only favorites updates for now. */
+export declare enum NotificationTypeEnum {
+    FAVORITE_PRICE_DROP = "favorite_price_drop",
+    FAVORITE_SOLD = "favorite_sold",
+    FAVORITE_BACK = "favorite_back",
+    FAVORITE_SIMILAR = "favorite_similar"
+}
+export type NotificationText = {
+    ar: string;
+    en: string;
+};
+export type INotificationData = {
+    ad_id?: number;
+    old_price?: number;
+    new_price?: number;
+    currency_id?: number | null;
+    /** FAVORITE_SIMILAR: the new ads and what they match */
+    ad_ids?: number[];
+    count?: number;
+    subject_type?: string;
+    category_id?: number | null;
+};
+export type INotification = {
+    id: number;
+    user_id: number;
+    type: NotificationTypeEnum;
+    title: NotificationText;
+    body: NotificationText;
+    ad_id: number | null;
+    ad?: IAd | null;
+    data: INotificationData | null;
+    /** Same key within 24 hours updates the existing row instead of adding one */
+    group_key: string | null;
+    read_at: Date | string | null;
+    push_status: "pending" | "sent" | "skipped" | "failed";
+    pushed_at: Date | string | null;
+    created_at: Date | string;
+    updated_at?: Date | string;
+};
+export type INotificationSetting = {
+    type: NotificationTypeEnum;
+    push_enabled: boolean;
+    inbox_enabled: boolean;
+};
+export type GetNotificationsDto = {
+    page?: number;
+    limit?: number;
+    type?: NotificationTypeEnum;
+};
+export type MarkNotificationsReadDto = {
+    ids?: number[];
+    all?: boolean;
+};
+export type UpdateNotificationSettingsDto = {
+    settings: INotificationSetting[];
+};

package/dist/cjs/types/communication/Notification.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationTypeEnum = void 0;
+/** Notifications kept in the user's notification centre. Only favorites updates for now. */
+var NotificationTypeEnum;
+(function (NotificationTypeEnum) {
+    NotificationTypeEnum["FAVORITE_PRICE_DROP"] = "favorite_price_drop";
+    NotificationTypeEnum["FAVORITE_SOLD"] = "favorite_sold";
+    NotificationTypeEnum["FAVORITE_BACK"] = "favorite_back";
+    NotificationTypeEnum["FAVORITE_SIMILAR"] = "favorite_similar";
+})(NotificationTypeEnum || (exports.NotificationTypeEnum = NotificationTypeEnum = {}));

package/dist/cjs/types/index.d.ts

@@ -57,6 +57,7 @@ export * as Chat from "./communication/Chat";
 export * as Device from "./communication/Device";
 export * as MessageTemplate from "./communication/MessageTemplate";
 export * as NotificationToken from "./communication/NotificationToken";
+export * as Notification from "./communication/Notification";
 export * as File from "./media/File";
 export * as Media from "./media/Media";
 export * as Image from "./media/Image";

package/dist/cjs/types/index.js

@@ -37,7 +37,7 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Favorite = exports.Wallet = exports.Permission = exports.Role = exports.User = exports.EventVenue = exports.EventWedding = exports.EventTimeline = exports.EventRsvp = exports.Event = exports.District = exports.City = exports.AdminBoundary = exports.WorkType = exports.UsedProductCondition = exports.UsedProductAge = exports.Unit = exports.Transmission = exports.RegionalSpec = exports.PublisherType = exports.PropertyStatus = exports.PriceType = exports.OfferType = exports.LicenseType = exports.FuelType = exports.Feature = exports.Facility = exports.Currency = exports.Color = exports.CategoryWorkType = exports.Category = exports.CarBody = exports.UsedProduct = exports.Service = exports.PropertySubType = exports.Property = exports.MotorTrim = exports.Motor = exports.AdPromotion = exports.Addresses = exports.AdDailyViews = exports.AdLocation = exports.Ad = exports.FilterParams = exports.ModuleFetchEndpoints = exports.Config = exports.AccessType = exports.Status = exports.Response = exports.LocalizedName = void 0;
-exports.Payment = exports.Analysis = exports.GeminiApiKey = exports.Google = exports.Kyc = exports.SocialMediaProfile = exports.SocialMediaPlatform = exports.Image = exports.Media = exports.File = exports.NotificationToken = exports.MessageTemplate = exports.Device = exports.Chat = exports.AppStartScreen = exports.MetaData = exports.Company = exports.PotentialUser = exports.Loyalty = void 0;
+exports.Payment = exports.Analysis = exports.GeminiApiKey = exports.Google = exports.Kyc = exports.SocialMediaProfile = exports.SocialMediaPlatform = exports.Image = exports.Media = exports.File = exports.Notification = exports.NotificationToken = exports.MessageTemplate = exports.Device = exports.Chat = exports.AppStartScreen = exports.MetaData = exports.Company = exports.PotentialUser = exports.Loyalty = void 0;
 // common
 exports.LocalizedName = __importStar(require("./common/LocalizedName"));
 exports.Response = __importStar(require("./common/Response"));
@@ -104,6 +104,7 @@ exports.Chat = __importStar(require("./communication/Chat"));
 exports.Device = __importStar(require("./communication/Device"));
 exports.MessageTemplate = __importStar(require("./communication/MessageTemplate"));
 exports.NotificationToken = __importStar(require("./communication/NotificationToken"));
+exports.Notification = __importStar(require("./communication/Notification"));
 // media
 exports.File = __importStar(require("./media/File"));
 exports.Media = __importStar(require("./media/Media"));

package/dist/cjs/types/user/Favorite.d.ts

@@ -4,11 +4,49 @@ export declare enum FavoritableType {
     USED_PRODUCTS = "used_products",
     SERVICES = "services"
 }
+/** A named group of the user's favorites, e.g. "Family car". Shared through share_token. */
+export type IFavoriteList = {
+    id: number;
+    user_id: number;
+    name: string;
+    share_token: string;
+    created_at?: Date | string;
+    /** Number of favorites in the list, sent with the user's lists */
+    count?: number;
+    /** Up to four ads for the list's cover */
+    preview_ads?: IAd[];
+};
 export type IFavorite = {
     id: number;
     user_id: number;
     user: IUser;
     created_at: Date | string;
     ad: IAd;
+    /** The ad's price and currency when it was saved, to show how much it dropped */
+    saved_price?: number | null;
+    saved_currency_id?: number | null;
+    /** The last price the user was notified about, so a drop is not announced twice */
+    last_notified_price?: number | null;
+    /** Price-drop, sold and back-on-sale alerts for this ad */
+    notify?: boolean;
+    /** Private note, only the user sees it */
+    note?: string | null;
+    list_id?: number | null;
 };
 export type FavoriteType = IFavorite;
+/** Availability of a favorite's ad, derived from its status and deletion */
+export declare enum FavoriteAvailability {
+    AVAILABLE = "available",
+    SOLD = "sold",
+    UNAVAILABLE = "unavailable"
+}
+export type UpdateFavoriteDto = {
+    ad_id: number;
+    note?: string | null;
+    notify?: boolean;
+    list_id?: number | null;
+};
+export type SaveFavoriteListDto = {
+    id?: number;
+    name: string;
+};

package/dist/cjs/types/user/Favorite.js

@@ -1,8 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FavoritableType = void 0;
+exports.FavoriteAvailability = exports.FavoritableType = void 0;
 var FavoritableType;
 (function (FavoritableType) {
     FavoritableType["USED_PRODUCTS"] = "used_products";
     FavoritableType["SERVICES"] = "services";
 })(FavoritableType || (exports.FavoritableType = FavoritableType = {}));
+/** Availability of a favorite's ad, derived from its status and deletion */
+var FavoriteAvailability;
+(function (FavoriteAvailability) {
+    FavoriteAvailability["AVAILABLE"] = "available";
+    FavoriteAvailability["SOLD"] = "sold";
+    FavoriteAvailability["UNAVAILABLE"] = "unavailable";
+})(FavoriteAvailability || (exports.FavoriteAvailability = FavoriteAvailability = {}));

package/dist/esm/constants/routes/app.js

@@ -2,6 +2,19 @@ export const APP_ROUTES = {
     main: {
         home: () => ({ pathname: "/(tabs)" }),
     },
+    notifications: {
+        /** The notification centre (favorites updates) */
+        list: () => ({ pathname: "/notifications" }),
+        settings: () => ({ pathname: "/notifications/settings" }),
+    },
+    favorites: {
+        compare: (ad_ids) => ({
+            pathname: "/favorites/compare",
+            params: { ids: ad_ids.join(",") },
+        }),
+        /** A favorites list someone shared */
+        sharedList: (token) => ({ pathname: "/favorites/list/[token]", params: { token } }),
+    },
     categories: {
         all: (params) => ({
             pathname: "/category/all-category",

package/dist/esm/types/communication/Notification.js

@@ -0,0 +1,8 @@
+/** Notifications kept in the user's notification centre. Only favorites updates for now. */
+export var NotificationTypeEnum;
+(function (NotificationTypeEnum) {
+    NotificationTypeEnum["FAVORITE_PRICE_DROP"] = "favorite_price_drop";
+    NotificationTypeEnum["FAVORITE_SOLD"] = "favorite_sold";
+    NotificationTypeEnum["FAVORITE_BACK"] = "favorite_back";
+    NotificationTypeEnum["FAVORITE_SIMILAR"] = "favorite_similar";
+})(NotificationTypeEnum || (NotificationTypeEnum = {}));

package/dist/esm/types/index.js

@@ -67,6 +67,7 @@ export * as Chat from "./communication/Chat.js";
 export * as Device from "./communication/Device.js";
 export * as MessageTemplate from "./communication/MessageTemplate.js";
 export * as NotificationToken from "./communication/NotificationToken.js";
+export * as Notification from "./communication/Notification.js";
 // media
 export * as File from "./media/File.js";
 export * as Media from "./media/Media.js";

package/dist/esm/types/user/Favorite.js

@@ -3,3 +3,10 @@ export var FavoritableType;
     FavoritableType["USED_PRODUCTS"] = "used_products";
     FavoritableType["SERVICES"] = "services";
 })(FavoritableType || (FavoritableType = {}));
+/** Availability of a favorite's ad, derived from its status and deletion */
+export var FavoriteAvailability;
+(function (FavoriteAvailability) {
+    FavoriteAvailability["AVAILABLE"] = "available";
+    FavoriteAvailability["SOLD"] = "sold";
+    FavoriteAvailability["UNAVAILABLE"] = "unavailable";
+})(FavoriteAvailability || (FavoriteAvailability = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deallony/shared",
-    "version": "1.2.69",
+    "version": "1.2.72",
     "private": false,
     "main": "dist/cjs/index.js",
     "module": "dist/esm/index.js",