@deallony/shared 1.2.75 → 1.2.79

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

@@ -1 +1,2 @@
 export * from "./app";
+export * from "./options";

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

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./app"), exports);
+__exportStar(require("./options"), exports);

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

@@ -0,0 +1,23 @@
+type RouteParam = string | number | boolean | null | undefined;
+export type AppRouteTarget = {
+    pathname: string;
+    params?: Record<string, RouteParam>;
+};
+/** An app screen an admin can link to (start app screens, banners, ...) */
+export type AppRouteOption = {
+    /** Stable id saved in the database, e.g. "wallet.details" */
+    key: string;
+    label: {
+        ar: string;
+        en: string;
+    };
+    route: AppRouteTarget;
+};
+/** App screens that open without an id, so they can be picked from a list */
+export declare const APP_ROUTE_OPTIONS: AppRouteOption[];
+/**
+ * The route saved on a record (an option key, or a raw "/path"), as something the app can open.
+ * Unknown keys return null so old apps never crash on a new key.
+ */
+export declare const resolveAppRoute: (value?: string | null) => AppRouteTarget | null;
+export {};

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

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveAppRoute = exports.APP_ROUTE_OPTIONS = void 0;
+const app_1 = require("./app");
+const option = (key, ar, en, route) => ({
+    key,
+    label: { ar, en },
+    route: route,
+});
+/** App screens that open without an id, so they can be picked from a list */
+exports.APP_ROUTE_OPTIONS = [
+    option("main.home", "الرئيسية", "Home", app_1.APP_ROUTES.main.home()),
+    option("ads.list", "كل الإعلانات", "All ads", app_1.APP_ROUTES.ads.list({})),
+    option("ads.new", "إضافة إعلان", "Add an ad", app_1.APP_ROUTES.ads.new()),
+    option("properties.add", "إضافة عقار", "Add a property", app_1.APP_ROUTES.properties.add()),
+    option("motor.add", "إضافة سيارة", "Add a vehicle", app_1.APP_ROUTES.motor.add()),
+    option("services.add", "إضافة خدمة", "Add a service", app_1.APP_ROUTES.services.add()),
+    option("product.save", "إضافة منتج", "Add a product", app_1.APP_ROUTES.product.save()),
+    option("user.myAds", "إعلاناتي", "My ads", app_1.APP_ROUTES.user.myAds()),
+    option("user.favorites", "المفضلة", "Favorites", app_1.APP_ROUTES.user.favorites()),
+    option("chat.chatlist", "المحادثات", "Chats", app_1.APP_ROUTES.chat.chatlist()),
+    option("notifications.list", "الإشعارات", "Notifications", app_1.APP_ROUTES.notifications.list()),
+    option("wallet.details", "المحفظة", "Wallet", app_1.APP_ROUTES.wallet.details()),
+    option("wallet.topup", "شحن المحفظة", "Top up wallet", app_1.APP_ROUTES.wallet.topup()),
+    option("user.referral", "دعوة الأصدقاء", "Invite friends", app_1.APP_ROUTES.user.referral()),
+    option("user.myReferralCode", "رمز الدعوة الخاص بي", "My referral code", app_1.APP_ROUTES.user.myReferralCode()),
+    option("user.myNumbers", "أرقامي", "My numbers", app_1.APP_ROUTES.user.myNumbers()),
+    option("addresses.list", "عناويني", "My addresses", app_1.APP_ROUTES.addresses.list()),
+    option("kyc.details", "توثيق الحساب", "Verify account", app_1.APP_ROUTES.kyc.details()),
+    option("company.list", "شركاتي", "My companies", app_1.APP_ROUTES.company.list()),
+    option("company.new", "إضافة شركة", "Add a company", app_1.APP_ROUTES.company.new()),
+    option("event.start", "إنشاء مناسبة", "Create an event", app_1.APP_ROUTES.event.start()),
+    option("event.mine", "مناسباتي", "My events", app_1.APP_ROUTES.event.mine()),
+    option("auth.login", "تسجيل الدخول", "Sign in", app_1.APP_ROUTES.auth.login()),
+    option("auth.editProfile", "تعديل الملف الشخصي", "Edit profile", app_1.APP_ROUTES.auth.editProfile()),
+    option("settings.selectCurrency", "اختيار العملة", "Choose currency", app_1.APP_ROUTES.settings.selectCurrency()),
+    option("system.general_settings", "الإعدادات", "Settings", app_1.APP_ROUTES.system.general_settings()),
+    option("support.tickets", "الدعم الفني", "Support", app_1.APP_ROUTES.support.tickets()),
+    option("system.contact", "تواصل معنا", "Contact us", app_1.APP_ROUTES.system.contact()),
+    option("system.download", "تحميل التطبيق", "Download the app", app_1.APP_ROUTES.system.download()),
+    option("system.privicy", "سياسة الخصوصية", "Privacy policy", app_1.APP_ROUTES.system.privicy()),
+];
+/**
+ * The route saved on a record (an option key, or a raw "/path"), as something the app can open.
+ * Unknown keys return null so old apps never crash on a new key.
+ */
+const resolveAppRoute = (value) => {
+    if (!value)
+        return null;
+    const found = exports.APP_ROUTE_OPTIONS.find((item) => item.key === value);
+    if (found)
+        return found.route;
+    if (value.startsWith("/"))
+        return { pathname: value };
+    return null;
+};
+exports.resolveAppRoute = resolveAppRoute;

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

@@ -6,4 +6,6 @@ export type IAppStartScreen = {
     created_at?: string;
     updated_at?: string;
     media: IMedia;
+    /** Where the slide opens in the app: a key from CONSTANTS.ROUTES.APP_ROUTE_OPTIONS */
+    route?: string | null;
 };

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

@@ -1 +1,2 @@
 export * from "./app.js";
+export * from "./options.js";

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

@@ -0,0 +1,53 @@
+import { APP_ROUTES } from "./app.js";
+const option = (key, ar, en, route) => ({
+    key,
+    label: { ar, en },
+    route: route,
+});
+/** App screens that open without an id, so they can be picked from a list */
+export const APP_ROUTE_OPTIONS = [
+    option("main.home", "الرئيسية", "Home", APP_ROUTES.main.home()),
+    option("ads.list", "كل الإعلانات", "All ads", APP_ROUTES.ads.list({})),
+    option("ads.new", "إضافة إعلان", "Add an ad", APP_ROUTES.ads.new()),
+    option("properties.add", "إضافة عقار", "Add a property", APP_ROUTES.properties.add()),
+    option("motor.add", "إضافة سيارة", "Add a vehicle", APP_ROUTES.motor.add()),
+    option("services.add", "إضافة خدمة", "Add a service", APP_ROUTES.services.add()),
+    option("product.save", "إضافة منتج", "Add a product", APP_ROUTES.product.save()),
+    option("user.myAds", "إعلاناتي", "My ads", APP_ROUTES.user.myAds()),
+    option("user.favorites", "المفضلة", "Favorites", APP_ROUTES.user.favorites()),
+    option("chat.chatlist", "المحادثات", "Chats", APP_ROUTES.chat.chatlist()),
+    option("notifications.list", "الإشعارات", "Notifications", APP_ROUTES.notifications.list()),
+    option("wallet.details", "المحفظة", "Wallet", APP_ROUTES.wallet.details()),
+    option("wallet.topup", "شحن المحفظة", "Top up wallet", APP_ROUTES.wallet.topup()),
+    option("user.referral", "دعوة الأصدقاء", "Invite friends", APP_ROUTES.user.referral()),
+    option("user.myReferralCode", "رمز الدعوة الخاص بي", "My referral code", APP_ROUTES.user.myReferralCode()),
+    option("user.myNumbers", "أرقامي", "My numbers", APP_ROUTES.user.myNumbers()),
+    option("addresses.list", "عناويني", "My addresses", APP_ROUTES.addresses.list()),
+    option("kyc.details", "توثيق الحساب", "Verify account", APP_ROUTES.kyc.details()),
+    option("company.list", "شركاتي", "My companies", APP_ROUTES.company.list()),
+    option("company.new", "إضافة شركة", "Add a company", APP_ROUTES.company.new()),
+    option("event.start", "إنشاء مناسبة", "Create an event", APP_ROUTES.event.start()),
+    option("event.mine", "مناسباتي", "My events", APP_ROUTES.event.mine()),
+    option("auth.login", "تسجيل الدخول", "Sign in", APP_ROUTES.auth.login()),
+    option("auth.editProfile", "تعديل الملف الشخصي", "Edit profile", APP_ROUTES.auth.editProfile()),
+    option("settings.selectCurrency", "اختيار العملة", "Choose currency", APP_ROUTES.settings.selectCurrency()),
+    option("system.general_settings", "الإعدادات", "Settings", APP_ROUTES.system.general_settings()),
+    option("support.tickets", "الدعم الفني", "Support", APP_ROUTES.support.tickets()),
+    option("system.contact", "تواصل معنا", "Contact us", APP_ROUTES.system.contact()),
+    option("system.download", "تحميل التطبيق", "Download the app", APP_ROUTES.system.download()),
+    option("system.privicy", "سياسة الخصوصية", "Privacy policy", APP_ROUTES.system.privicy()),
+];
+/**
+ * The route saved on a record (an option key, or a raw "/path"), as something the app can open.
+ * Unknown keys return null so old apps never crash on a new key.
+ */
+export const resolveAppRoute = (value) => {
+    if (!value)
+        return null;
+    const found = APP_ROUTE_OPTIONS.find((item) => item.key === value);
+    if (found)
+        return found.route;
+    if (value.startsWith("/"))
+        return { pathname: value };
+    return null;
+};

package/package.json

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