@cravery/types 0.0.7 → 0.0.9

package/src/core/errors.ts

@@ -1,118 +1,273 @@
-export const APP_ERROR_CODE_VALUES = [
+import { UnixTimestamp } from "./timestamp";
+
+export const APP_ERROR_CODES = [
   "bad-request",
-  "conflict",
-  "daily-limit-reached",
+  "unauthorized",
   "forbidden",
-  "internal-error",
-  "low-confidence",
-  "monthly-limit-reached",
   "not-found",
-  "no-recipe-found",
-  "unauthorized",
-  "unsafe-content",
+  "conflict",
   "validation-error",
+  "quota-exceeded",
+  "rate-limited",
+  "internal-error",
+  "service-unavailable",
 ] as const;
-export type AppErrorCode = (typeof APP_ERROR_CODE_VALUES)[number];
+
+export type AppErrorCode = (typeof APP_ERROR_CODES)[number];
+
+export const HTTP_STATUS_MAP: Record<AppErrorCode, number> = {
+  "bad-request": 400,
+  unauthorized: 401,
+  forbidden: 403,
+  "not-found": 404,
+  conflict: 409,
+  "validation-error": 422,
+  "quota-exceeded": 429,
+  "rate-limited": 429,
+  "internal-error": 500,
+  "service-unavailable": 503,
+};
+
+export interface BaseErrorContext {
+  requestId?: string;
+  [key: string]: unknown;
+}
+
+export interface ValidationErrorContext extends BaseErrorContext {
+  fields: Array<{
+    path: string;
+    message: string;
+    code?: string;
+  }>;
+}
+
+export interface QuotaErrorContext extends BaseErrorContext {
+  quotaType: "daily" | "monthly";
+  resource: string;
+  limit: number;
+  used: number;
+  resetsAt?: UnixTimestamp;
+}
+
+export interface RateLimitErrorContext extends BaseErrorContext {
+  retryAfterSeconds?: number;
+}
+
+export interface NotFoundErrorContext extends BaseErrorContext {
+  resourceType: string;
+  resourceId?: string;
+}
 
 export class AppError extends Error {
   public readonly code: AppErrorCode;
-  public readonly context?: Record<string, unknown>;
+  public readonly context: BaseErrorContext;
+  public readonly statusCode: number;
 
   constructor(
     code: AppErrorCode,
     message: string,
-    context?: Record<string, unknown>,
+    context: BaseErrorContext = {},
   ) {
     super(message);
     this.name = "AppError";
     this.code = code;
     this.context = context;
+    this.statusCode = HTTP_STATUS_MAP[code];
 
     if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, AppError);
+      Error.captureStackTrace(this, this.constructor);
     }
+    Object.setPrototypeOf(this, new.target.prototype);
   }
+  toJSON(): {
+    code: AppErrorCode;
+    message: string;
+    details?: Record<string, unknown>;
+    requestId?: string;
+  } {
+    const { requestId, ...details } = this.context;
 
-  toJSON() {
     return {
-      name: this.name,
       code: this.code,
       message: this.message,
-      context: this.context,
+      ...(Object.keys(details).length > 0 && { details }),
+      ...(requestId && { requestId }),
     };
   }
+  withRequestId(requestId: string): AppError {
+    return new (this.constructor as typeof AppError)(this.code, this.message, {
+      ...this.context,
+      requestId,
+    });
+  }
 }
 
-export class ValidationError extends AppError {
-  constructor(message: string, context?: Record<string, unknown>) {
-    super("validation-error", message, context);
-    this.name = "ValidationError";
-  }
+export function isAppError(error: unknown): error is AppError {
+  return error instanceof AppError;
 }
 
-export class NotFoundError extends AppError {
-  constructor(message: string, context?: Record<string, unknown>) {
-    super("not-found", message, context);
-    this.name = "NotFoundError";
+export function isAppErrorCode(code: unknown): code is AppErrorCode {
+  return (
+    typeof code === "string" && APP_ERROR_CODES.includes(code as AppErrorCode)
+  );
+}
+
+export class BadRequestError extends AppError {
+  constructor(message: string, context: BaseErrorContext = {}) {
+    super("bad-request", message, context);
+    this.name = "BadRequestError";
   }
 }
 
 export class UnauthorizedError extends AppError {
-  constructor(message: string, context?: Record<string, unknown>) {
+  constructor(
+    message: string = "Authentication required",
+    context: BaseErrorContext = {},
+  ) {
     super("unauthorized", message, context);
     this.name = "UnauthorizedError";
   }
 }
 
 export class ForbiddenError extends AppError {
-  constructor(message: string, context?: Record<string, unknown>) {
+  constructor(
+    message: string = "You do not have permission to perform this action",
+    context: BaseErrorContext = {},
+  ) {
     super("forbidden", message, context);
     this.name = "ForbiddenError";
   }
 }
 
+export class NotFoundError extends AppError {
+  constructor(
+    resourceType: string,
+    resourceId?: string,
+    context: Omit<NotFoundErrorContext, "resourceType" | "resourceId"> = {},
+  ) {
+    const message = resourceId
+      ? `${resourceType} not found: ${resourceId}`
+      : `${resourceType} not found`;
+    super("not-found", message, { ...context, resourceType, resourceId });
+    this.name = "NotFoundError";
+  }
+}
+
 export class ConflictError extends AppError {
-  constructor(message: string, context?: Record<string, unknown>) {
+  constructor(message: string, context: BaseErrorContext = {}) {
     super("conflict", message, context);
     this.name = "ConflictError";
   }
 }
 
-export class DailyLimitError extends AppError {
-  constructor(message: string, context?: Record<string, unknown>) {
-    super("daily-limit-reached", message, context);
-    this.name = "DailyLimitError";
+export class ValidationError extends AppError {
+  public readonly fields: ValidationErrorContext["fields"];
+
+  constructor(
+    message: string,
+    fields: ValidationErrorContext["fields"] = [],
+    context: Omit<ValidationErrorContext, "fields"> = {},
+  ) {
+    super("validation-error", message, { ...context, fields });
+    this.name = "ValidationError";
+    this.fields = fields;
+  }
+
+  static fromFieldErrors(
+    fields: ValidationErrorContext["fields"],
+    context: Omit<ValidationErrorContext, "fields"> = {},
+  ): ValidationError {
+    const message =
+      fields.length === 1
+        ? fields[0].message
+        : `Validation failed: ${fields.length} errors`;
+    return new ValidationError(message, fields, context);
   }
 }
 
-export class MonthlyLimitError extends AppError {
-  constructor(message: string, context?: Record<string, unknown>) {
-    super("monthly-limit-reached", message, context);
-    this.name = "MonthlyLimitError";
+export class QuotaExceededError extends AppError {
+  public readonly quotaType: "daily" | "monthly";
+  public readonly resource: string;
+  public readonly limit: number;
+  public readonly used: number;
+  public readonly resetsAt?: string;
+
+  constructor(
+    quotaType: "daily" | "monthly",
+    resource: string,
+    limit: number,
+    used: number,
+    resetsAt?: string,
+    context: Omit<
+      QuotaErrorContext,
+      "quotaType" | "resource" | "limit" | "used" | "resetsAt"
+    > = {},
+  ) {
+    const message = `${quotaType.charAt(0).toUpperCase() + quotaType.slice(1)} ${resource} limit reached (${used}/${limit})`;
+    super("quota-exceeded", message, {
+      ...context,
+      quotaType,
+      resource,
+      limit,
+      used,
+      resetsAt,
+    });
+    this.name = "QuotaExceededError";
+    this.quotaType = quotaType;
+    this.resource = resource;
+    this.limit = limit;
+    this.used = used;
+    this.resetsAt = resetsAt;
   }
 }
 
-export class NoRecipeFoundError extends AppError {
-  constructor(reason: string, context?: Record<string, unknown>) {
-    super("no-recipe-found", reason, context);
-    this.name = "NoRecipeFoundError";
+export class RateLimitedError extends AppError {
+  public readonly retryAfterSeconds?: number;
+
+  constructor(
+    message: string = "Too many requests. Please try again later.",
+    retryAfterSeconds?: number,
+    context: Omit<RateLimitErrorContext, "retryAfterSeconds"> = {},
+  ) {
+    super("rate-limited", message, { ...context, retryAfterSeconds });
+    this.name = "RateLimitedError";
+    this.retryAfterSeconds = retryAfterSeconds;
   }
 }
 
-export class LowConfidenceError extends AppError {
-  constructor(confidence: number, context?: Record<string, unknown>) {
-    super(
-      "low-confidence",
-      "We couldn't extract a complete recipe. Try a clearer image or more detailed text.",
-      { ...context, confidence },
-    );
-    this.name = "LowConfidenceError";
+export class InternalError extends AppError {
+  constructor(
+    message: string = "An unexpected error occurred",
+    context: BaseErrorContext = {},
+  ) {
+    super("internal-error", message, context);
+    this.name = "InternalError";
+  }
+
+  static wrap(error: unknown, context: BaseErrorContext = {}): InternalError {
+    const message =
+      error instanceof Error ? error.message : "An unexpected error occurred";
+    return new InternalError(message, {
+      ...context,
+      originalError:
+        error instanceof Error
+          ? { name: error.name, message: error.message }
+          : String(error),
+    });
   }
 }
 
-export class UnsafeContentError extends AppError {
-  constructor(context?: Record<string, unknown>) {
-    super("unsafe-content", "This content cannot be processed.", context);
-    this.name = "UnsafeContentError";
+export class ServiceUnavailableError extends AppError {
+  constructor(
+    service: string,
+    message?: string,
+    context: BaseErrorContext = {},
+  ) {
+    super(
+      "service-unavailable",
+      message ?? `${service} is temporarily unavailable`,
+      { ...context, service },
+    );
+    this.name = "ServiceUnavailableError";
   }
 }

package/src/core/index.ts

@@ -2,6 +2,5 @@ export * from "./entity";
 export * from "./errors";
 export * from "./locale";
 export * from "./pagination";
-export * from "./region";
 export * from "./theme";
 export * from "./timestamp";

package/src/core/locale.ts

@@ -1,2 +1,6 @@
 export const LOCALE_VALUES = ["en", "ar", "es"] as const;
 export type Locale = (typeof LOCALE_VALUES)[number];
+
+export type LocalizedString = { en: string } & Partial<
+  Record<Exclude<Locale, "en">, string>
+>;

package/src/core/timestamp.ts

@@ -1,4 +1 @@
-export interface Timestamp {
-  seconds: number;
-  nanoseconds: number;
-}
+export type UnixTimestamp = number;

package/src/equipment/entity.ts

@@ -1,18 +1,11 @@
 import { Currency } from "../common";
-import { Entity } from "../core";
+import { Entity, LocalizedString } from "../core";
 import { EquipmentCategory } from "./category";
 
-export interface EquipmentEntityMeta extends Entity {
+export interface EquipmentEntity extends Entity {
   category: EquipmentCategory;
   cost: Currency;
+  imagePath: string | null;
+  name: LocalizedString;
   slug: string;
-  imageUrl: string | null;
 }
-
-export interface EquipmentEntityContent {
-  name: string;
-  slug: string;
-}
-
-export interface EquipmentEntity
-  extends EquipmentEntityMeta, EquipmentEntityContent {}

package/src/equipment/user.ts

@@ -1,14 +1,12 @@
 import { Currency } from "../common";
-import { Entity } from "../core";
+import { Entity, LocalizedString } from "../core";
 import { EquipmentCategory } from "./category";
 
-export interface UserEquipment extends Entity {
+export interface UserEquipmentEntity extends Entity {
   category: EquipmentCategory;
   cost: Currency;
+  imagePath: string | null;
+  name: LocalizedString;
   quantity: number;
   slug: string;
 }
-
-export interface LocalizedUserEquipment extends UserEquipment {
-  name: string;
-}

package/src/feed/recipe.ts

@@ -7,7 +7,7 @@ import {
   MealType,
   Spiciness,
 } from "../common";
-import { Entity, Locale } from "../core";
+import { Entity, LocalizedString } from "../core";
 import { RecipeStats } from "../recipes";
 import { FeedCategory } from "./category";
 
@@ -21,7 +21,7 @@ export interface RecipeFeedItem extends Entity {
   images: string[];
   mealTypes: MealType[];
   spiciness: Spiciness;
-  titles: Record<Locale, string>;
+  titles: LocalizedString;
 }
 
 export interface FeedRecipe extends RecipeFeedItem {
@@ -30,6 +30,6 @@ export interface FeedRecipe extends RecipeFeedItem {
 
 export interface FeedGroup {
   category: FeedCategory;
-  titles: Record<Locale, string>;
+  titles: LocalizedString;
   recipes: FeedRecipe[];
 }

package/src/index.ts

@@ -2,7 +2,6 @@ export * from "./common";
 export * from "./core";
 export * from "./equipment";
 export * from "./feed";
-export * from "./iam";
 export * from "./ingredients";
 export * from "./limits";
 export * from "./mealplan";
@@ -10,4 +9,5 @@ export * from "./recipes";
 export * from "./reports";
 export * from "./settings";
 export * from "./shopping";
-export * from "./subscriptions";
+export * from "./subscription";
+export * from "./users";

package/src/ingredients/entity.ts

@@ -1,21 +1,14 @@
 import { Currency, Unit } from "../common";
-import { Entity } from "../core";
+import { Entity, LocalizedString } from "../core";
 import { IngredientCategory } from "./category";
 import { IngredientGroup } from "./group";
 
-export interface IngredientEntityMeta extends Entity {
+export interface IngredientEntity extends Entity {
   category: IngredientCategory;
   cost: Currency;
   group: IngredientGroup;
-  imageUrl: string | null;
+  imagePath: string | null;
+  name: LocalizedString;
   slug: string;
   standardUnit: Unit;
 }
-
-export interface IngredientEntityContent {
-  name: string;
-  slug: string;
-}
-
-export interface IngredientEntity
-  extends IngredientEntityMeta, IngredientEntityContent {}

package/src/ingredients/user.ts

@@ -1,18 +1,16 @@
 import { Currency, Unit } from "../common";
-import { Entity, Timestamp } from "../core";
+import { Entity, LocalizedString, UnixTimestamp } from "../core";
 import { IngredientCategory } from "./category";
 import { IngredientGroup } from "./group";
 
 export interface UserIngredient extends Entity {
   category: IngredientCategory;
   cost: Currency;
-  expiresAt: Timestamp | null;
+  expiresAt: UnixTimestamp | null;
   group: IngredientGroup;
+  imagePath: string | null;
+  name: LocalizedString;
   slug: string;
   quantity: number;
   unit: Unit;
 }
-
-export interface LocalizedUserIngredient extends UserIngredient {
-  name: string;
-}

package/src/limits/limits.ts

@@ -1,4 +1,4 @@
-import { SubscriptionTier } from "../subscriptions";
+import { SubscriptionTier } from "../subscription";
 import { Operation } from "./operation";
 
 export type TierLimits = Record<SubscriptionTier, number>;

package/src/limits/usage.ts

@@ -1,9 +1,15 @@
-import { Timestamp } from "../core";
+import { UnixTimestamp } from "../core";
 import { Operation } from "./operation";
 
 export type UsageCounts = Partial<Record<Operation, number>>;
 
 export interface UsagePeriod {
   counts: UsageCounts;
-  updatedAt: Timestamp;
+  resetAt: UnixTimestamp;
+  updatedAt: UnixTimestamp;
+}
+
+export interface UserQuotas {
+  daily: UsagePeriod;
+  monthly: UsagePeriod;
 }

package/src/recipes/index.ts

@@ -6,5 +6,4 @@ export * from "./recipe";
 export * from "./request";
 export * from "./source";
 export * from "./stats";
-export * from "./status";
 export * from "./user";

package/src/recipes/meta.ts

@@ -14,7 +14,6 @@ import { RecipeEquipmentMeta } from "../equipment";
 import { IngredientSectionMeta } from "../ingredients";
 import { InstructionMeta } from "./instruction";
 import { RecipeSource } from "./source";
-import { RecipeStatus } from "./status";
 
 export interface RecipeMeta extends Entity {
   allergens: Allergen[];
@@ -37,6 +36,5 @@ export interface RecipeMeta extends Entity {
   source: RecipeSource;
   sourceRef: string;
   spiciness: Spiciness;
-  status: RecipeStatus;
   videoUrl?: string;
 }

package/src/recipes/recipe.ts

@@ -13,7 +13,6 @@ import {
 import { RecipeEquipment } from "../equipment";
 import { IngredientSection } from "../ingredients";
 import { Instruction } from "./instruction";
-import { RecipeStatus } from "./status";
 
 export interface Recipe extends Entity {
   allergens: Allergen[];
@@ -32,7 +31,6 @@ export interface Recipe extends Entity {
   nutrition: Nutrition;
   servings: number;
   spiciness: Spiciness;
-  status: RecipeStatus;
   tips: string[];
   title: string;
   videoUrl?: string;

package/src/recipes/request.ts

@@ -1,4 +1,4 @@
-import { Entity, Timestamp } from "../core";
+import { Entity, UnixTimestamp } from "../core";
 import { Locale } from "../core/locale";
 import { RecipeSource } from "./source";
 
@@ -22,5 +22,5 @@ export interface RecipeRequest extends Entity {
   status: RequestStatus;
   userId: string;
   error?: string;
-  processedAt: Timestamp | null;
+  processedAt: UnixTimestamp | null;
 }

package/src/recipes/stats.ts

@@ -1,3 +1,5 @@
+import { UnixTimestamp } from "../core";
+
 export interface RecipeStats {
   cooks: number;
   ratingCount: number;
@@ -5,5 +7,5 @@ export interface RecipeStats {
   saves: number;
   shares: number;
   score: number;
-  updatedAt: number;
+  updatedAt: UnixTimestamp;
 }

package/src/recipes/user.ts

@@ -1,10 +1,10 @@
-import { Entity, Timestamp } from "../core";
+import { Entity, UnixTimestamp } from "../core";
 
 export interface UserRecipe extends Entity {
   recipeId: string;
-  cookedAt: Timestamp | null;
+  cookedAt: UnixTimestamp | null;
   cookedCount: number;
   notes?: string;
   rating?: number;
-  savedAt: Timestamp | null;
+  savedAt: UnixTimestamp | null;
 }

package/src/reports/report.ts

@@ -11,8 +11,5 @@ export interface Report extends Entity {
   reporterId: string;
   submission: ReportSubmission;
   target: ReportTarget;
-}
-
-export interface UpdatedReport extends Report {
   updates: ReportUpdate[];
 }

package/src/settings/settings.ts

@@ -23,5 +23,6 @@ export interface Settings extends Entity {
   spiciness: Spiciness;
   temperatureUnit: TemperatureUnit;
   textScale: number;
+  timezone: string;
   theme: Theme;
 }

package/src/shopping/equipment.ts

@@ -1,7 +1,12 @@
+import { Currency } from "../common";
+import { LocalizedString } from "../core";
 import { ShoppingItemStatus } from "./item_status";
 
 export interface ShoppingEquipment {
-  slug: string;
+  cost: Currency;
+  imagePath: string | null;
+  name: LocalizedString;
   quantity: number;
+  slug: string;
   status: ShoppingItemStatus;
 }

package/src/shopping/ingredient.ts

@@ -1,9 +1,16 @@
-import { Unit } from "../common";
+import { Currency, Unit } from "../common";
+import { LocalizedString } from "../core";
+import { IngredientCategory, IngredientGroup } from "../ingredients";
 import { ShoppingItemStatus } from "./item_status";
 
 export interface ShoppingIngredient {
-  slug: string;
+  category: IngredientCategory;
+  cost: Currency;
+  group: IngredientGroup;
+  imagePath: string | null;
+  name: LocalizedString;
   quantity: number;
-  unit: Unit;
+  slug: string;
   status: ShoppingItemStatus;
+  unit: Unit;
 }

package/src/subscription/index.ts

@@ -0,0 +1,9 @@
+export * from "./billing";
+export * from "./member_status";
+export * from "./member";
+export * from "./role";
+export * from "./sharing";
+export * from "./store";
+export * from "./status";
+export * from "./tier";
+export * from "./subscription";

package/src/{subscriptions → subscription}/member.ts

@@ -1,9 +1,9 @@
-import { Timestamp } from "../core";
+import { UnixTimestamp } from "../core";
 import { MemberStatus } from "./member_status";
-import { SubscriptionRole } from "./subscription_role";
+import { SubscriptionRole } from "./role";
 
 export interface Member {
-  joinedAt: Timestamp | null;
+  joinedAt: UnixTimestamp | null;
   role: SubscriptionRole;
   status: MemberStatus;
   userId: string;