sahab-utils 2.0.0 → 2.1.1

package/dist/constants/types.d.ts

@@ -845,8 +845,6 @@ export type AppSettings = {
     pushTransport?: PushTransport;
     /** Kill switch for staff push broadcasts. Off unless true; test sends to the dev team still work. */
     broadcastEnabled?: boolean;
-    /** Staff push for an order that used a car Sahab has not verified. Off unless true, so deploying does not send one per model already in use. */
-    carReviewAlertsEnabled?: boolean;
 };
 export type OrderReview = {
     ratingId: string;

package/dist/ts/adminNotifications.d.ts

@@ -1,10 +1,10 @@
 import type { Permissions, StaffRole } from './staffAccess';
 /** Which alerts a back-office admin gets. The shared contract between sahab-website (the Admin notifications page) and cloudFun. */
 /** App (push) alerts, each sent to the admin's customer-app account. */
-export declare const ADMIN_PUSH_KINDS: readonly ["newOrder", "newCarwash", "newGift", "newClient", "needsAttention", "statements"];
+export declare const ADMIN_PUSH_KINDS: readonly ["newOrder", "newCarwash", "newGift", "newClient", "newCarModel", "needsAttention", "statements"];
 export type AdminPushKind = (typeof ADMIN_PUSH_KINDS)[number];
 /** Every switch on the page: the app alerts plus the lead e-mail. */
-export declare const ADMIN_NOTIFICATION_KEYS: readonly ["newOrder", "newCarwash", "newGift", "newClient", "needsAttention", "statements", "leadEmails"];
+export declare const ADMIN_NOTIFICATION_KEYS: readonly ["newOrder", "newCarwash", "newGift", "newClient", "newCarModel", "needsAttention", "statements", "leadEmails"];
 export type AdminNotificationKey = (typeof ADMIN_NOTIFICATION_KEYS)[number];
 export type AdminNotificationPrefs = Record<AdminNotificationKey, boolean>;
 export declare const ADMIN_NOTIFICATION_LABELS: Record<AdminNotificationKey, {

package/dist/ts/adminNotifications.js

@@ -4,7 +4,7 @@ exports.isValidAppUid = exports.isValidAdminEmail = exports.normalizeAdminEmail
 exports.normalizeAdminNotificationPrefs = normalizeAdminNotificationPrefs;
 /** Which alerts a back-office admin gets. The shared contract between sahab-website (the Admin notifications page) and cloudFun. */
 /** App (push) alerts, each sent to the admin's customer-app account. */
-exports.ADMIN_PUSH_KINDS = ['newOrder', 'newCarwash', 'newGift', 'newClient', 'needsAttention', 'statements'];
+exports.ADMIN_PUSH_KINDS = ['newOrder', 'newCarwash', 'newGift', 'newClient', 'newCarModel', 'needsAttention', 'statements'];
 /** Every switch on the page: the app alerts plus the lead e-mail. */
 exports.ADMIN_NOTIFICATION_KEYS = [...exports.ADMIN_PUSH_KINDS, 'leadEmails'];
 exports.ADMIN_NOTIFICATION_LABELS = {
@@ -12,6 +12,7 @@ exports.ADMIN_NOTIFICATION_LABELS = {
     newCarwash: { label: 'New carwash', description: 'A carwash registers or finishes its registration.' },
     newGift: { label: 'New gift', description: 'A customer buys a gift.' },
     newClient: { label: 'New customer', description: 'A customer joins the app.' },
+    newCarModel: { label: 'Car model to review', description: 'An order uses a car model Sahab has not reviewed yet.' },
     needsAttention: { label: 'Carwash needs attention', description: 'A carwash changed something that needs a look.' },
     statements: { label: 'Statements', description: 'The daily and weekly statements are ready.' },
     leadEmails: { label: 'Lead e-mails', description: 'A visitor sends an enquiry or a carwash request on the website.' },

package/dist/ts/carCatalogue.d.ts

@@ -10,10 +10,12 @@ export declare const CAR_REVIEW_QUEUES: readonly ["pending", "declined", "needs_
 export type CarReviewQueue = (typeof CAR_REVIEW_QUEUES)[number];
 /** An alias document counts toward this many per model, so a fix can find every key with one `in` query (Firestore allows 30). */
 export declare const MAX_ALIASES = 29;
+/** `ar` is the model's official Arabic name (`nameAr`); aliases are never shown to customers. */
 export type CarPickerEntry = {
     id: string;
     name: string;
     size: CarSize;
+    ar?: string;
 };
 /** `car_makes/{makeKey}`. `T` is the timestamp type of whichever Firestore SDK reads or writes it. */
 export type CarMakeDoc<T = TimestampType> = {
@@ -31,6 +33,8 @@ export type CarModelDoc<T = TimestampType> = {
     makeEn: string;
     status: CarModelStatus;
     name: string;
+    /** The one official Arabic name, set by staff. Other Arabic spellings are aliases and stay internal. */
+    nameAr?: string;
     size: CarSize;
     aliasKeys?: string[];
     aliases?: string[];
@@ -55,6 +59,7 @@ export type CarQueueSort = (typeof CAR_QUEUE_SORTS)[number];
 export type CarCatalogueEntry = {
     modelId: string;
     name: string;
+    nameAr?: string;
     aliases: string[];
     size: CarSize;
     source: CarModelSource;
@@ -123,7 +128,10 @@ export declare function isCarVerified(car: Partial<Car> | undefined): boolean;
 /** The active models of a make as the customer picker lists them: sorted by name, never an alias, pending or declined model. */
 export declare function buildPicker(models: ({
     id: string;
-} & Pick<CarModelDoc, 'status' | 'name' | 'size'>)[]): CarPickerEntry[];
+    ar?: string;
+} & Pick<CarModelDoc, 'status' | 'name' | 'size' | 'nameAr'>)[]): CarPickerEntry[];
+/** An official Arabic name: trimmed, one line, at most `CAR_NAME_MAX_LENGTH` characters and written in Arabic. */
+export declare const isValidArabicName: (value: unknown) => value is string;
 /** The picker with one active model added, or replaced if it is already there. */
 export declare function withPickerEntry(picker: CarPickerEntry[] | undefined, entry: CarPickerEntry): CarPickerEntry[];
 /** Every key a model's cars may carry: its own and those of the aliases merged into it. */

package/dist/ts/carCatalogue.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PLATE_NUMBER_MAX = exports.PLATE_LETTERS_MAX = exports.CAR_CATALOGUE_INDEX_ID = exports.joinModelKey = exports.isCarSize = exports.CAR_SIZE_INFO = exports.CAR_QUEUE_SORTS = exports.MAX_ALIASES = exports.CAR_REVIEW_QUEUES = exports.CAR_MODEL_STATUSES = exports.CAR_NAME_MAX_LENGTH = exports.CAR_MODEL_MAX_LENGTH = void 0;
+exports.PLATE_NUMBER_MAX = exports.PLATE_LETTERS_MAX = exports.CAR_CATALOGUE_INDEX_ID = exports.isValidArabicName = exports.joinModelKey = exports.isCarSize = exports.CAR_SIZE_INFO = exports.CAR_QUEUE_SORTS = exports.MAX_ALIASES = exports.CAR_REVIEW_QUEUES = exports.CAR_MODEL_STATUSES = exports.CAR_NAME_MAX_LENGTH = exports.CAR_MODEL_MAX_LENGTH = void 0;
 exports.normalizeCarText = normalizeCarText;
 exports.carModelKey = carModelKey;
 exports.parseTypedCarModel = parseTypedCarModel;
@@ -80,9 +80,16 @@ function isCarVerified(car) {
 function buildPicker(models) {
     return models
         .filter((model) => model.status === 'active')
-        .map(({ id, name, size }) => ({ id, name, size }))
+        .map(({ id, name, size, nameAr, ar }) => {
+        const arabic = nameAr || ar;
+        return Object.assign({ id, name, size }, (arabic ? { ar: arabic } : {}));
+    })
         .sort((a, b) => a.name.localeCompare(b.name) || a.id.localeCompare(b.id));
 }
+const ARABIC_LETTER = /[\u0600-\u06FF]/;
+/** An official Arabic name: trimmed, one line, at most `CAR_NAME_MAX_LENGTH` characters and written in Arabic. */
+const isValidArabicName = (value) => typeof value === 'string' && value === value.trim() && value.length > 0 && value.length <= exports.CAR_NAME_MAX_LENGTH && !/[\r\n]/.test(value) && ARABIC_LETTER.test(value);
+exports.isValidArabicName = isValidArabicName;
 /** The picker with one active model added, or replaced if it is already there. */
 function withPickerEntry(picker, entry) {
     return buildPicker([...(picker !== null && picker !== void 0 ? picker : []).filter((existing) => existing.id !== entry.id), entry].map((item) => (Object.assign(Object.assign({}, item), { status: 'active' }))));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sahab-utils",
-	"version": "2.0.0",
+	"version": "2.1.1",
 	"description": "This package contains types and utils functions",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",