@plyaz/types 1.13.17 → 1.14.0

package/dist/auth/index.js

@@ -42,13 +42,17 @@ var AUTH_PROVIDER_TYPE = /* @__PURE__ */ ((AUTH_PROVIDER_TYPE2) => {
   AUTH_PROVIDER_TYPE2["InternalDb"] = "INTERNAL_DB";
   return AUTH_PROVIDER_TYPE2;
 })(AUTH_PROVIDER_TYPE || {});
-var loginCredentialsSchema = z.object({
-  // The user's email address. Must be a valid email format.
-  email: z.string().email("Invalid email format"),
-  // The user's password. No format constraints applied here.
-  password: z.string()
+var DEFAULT_PASSWORD = 8;
+var ContactUsFormSchema = z.object({
+  name: z.string({ error: "errors.form.missingField" }).min(1, "errors.form.nameMissing"),
+  email: z.email({ error: "errors.form.emailInvalid" })
+});
+var SignupFormSchema = z.object({
+  name: z.string({ error: "errors.form.missingField" }).min(1, "errors.form.nameMissing"),
+  email: z.email({ error: "errors.form.emailInvalid" }),
+  password: z.string({ error: "errors.form.missingField" }).min(DEFAULT_PASSWORD, "errors.form.passwordTooShort")
 });
 
-export { AUTH_PROVIDER, AUTH_PROVIDER_TYPE, USER_ROLE, USER_STATUS, loginCredentialsSchema };
+export { AUTH_PROVIDER, AUTH_PROVIDER_TYPE, ContactUsFormSchema, SignupFormSchema, USER_ROLE, USER_STATUS };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/auth/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/auth/enums.ts","../../src/auth/schemas.ts"],"names":["AUTH_PROVIDER_TYPE"],"mappings":";;;;;AAYO,IAAM,SAAA,GAAY;AAAA;AAAA,EAEvB,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,IAAA,EAAM,MAAA;AAAA;AAAA,EAGN,GAAA,EAAK,KAAA;AAAA;AAAA,EAGL,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,UAAA,EAAY;AACd;AAcO,IAAM,WAAA,GAAc;AAAA;AAAA,EAEzB,MAAA,EAAQ,QAAA;AAAA;AAAA,EAGR,QAAA,EAAU,UAAA;AAAA;AAAA,EAGV,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,SAAA,EAAW,WAAA;AAAA;AAAA,EAGX,MAAA,EAAQ;AACV;AAcO,IAAM,aAAA,GAAgB;AAAA;AAAA,EAE3B,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,MAAA,EAAQ;AACV;AAEO,IAAK,kBAAA,qBAAAA,mBAAAA,KAAL;AACL,EAAAA,oBAAA,eAAA,CAAA,GAAgB,gBAAA;AAChB,EAAAA,oBAAA,YAAA,CAAA,GAAa,aAAA;AAFH,EAAA,OAAAA,mBAAAA;AAAA,CAAA,EAAA,kBAAA,IAAA,EAAA;ACvEL,IAAM,sBAAA,GAAyB,EAAE,MAAA,CAAO;AAAA;AAAA,EAE7C,KAAA,EAAO,CAAA,CAAE,MAAA,EAAO,CAAE,MAAM,sBAAsB,CAAA;AAAA;AAAA,EAG9C,QAAA,EAAU,EAAE,MAAA;AACd,CAAC","file":"index.js","sourcesContent":["/**\n * Enum representing the different roles a user can have within the system.\n * @description Roles are used to determine access levels, permissions, and user-specific experiences.\n *\n * @example\n * ```typescript\n * import { USER_ROLE } from '@plyaz/types';\n *\n * const userRole = USER_ROLE.Athlete; // 'athlete'\n * const isAdmin = userRole === USER_ROLE.Admin || userRole === USER_ROLE.SuperAdmin;\n * ```\n */\nexport const USER_ROLE = {\n  /** A user who is an athlete and participates in sports activities. */\n  Athlete: 'athlete',\n\n  /** A user who scouts and discovers talent. */\n  Scout: 'scout',\n\n  /** A user who acts as an agent representing athletes or clubs. */\n  Agent: 'agent',\n\n  /** A user representing a sports club or organization. */\n  Club: 'club',\n\n  /** A fan or supporter of athletes or clubs. */\n  Fan: 'fan',\n\n  /** A system administrator with access to management tools. */\n  Admin: 'admin',\n\n  /** A super admin with the highest level of access and control. */\n  SuperAdmin: 'super.admin',\n} as const;\n\n/**\n * Enum representing the current status of a user account.\n * @description Statuses are used to determine login availability, visibility, and user flow.\n *\n * @example\n * ```typescript\n * import { USER_STATUS } from '@plyaz/types';\n *\n * const isAccessible = status === USER_STATUS.Active;\n * const needsReview = status === USER_STATUS.Pending;\n * ```\n */\nexport const USER_STATUS = {\n  /** Active user with full access. */\n  Active: 'active',\n\n  /** Inactive user, typically not currently using the platform. */\n  Inactive: 'inactive',\n\n  /** User account is awaiting approval or completion of setup. */\n  Pending: 'pending',\n\n  /** User has been temporarily suspended due to policy violations or manual review. */\n  Suspended: 'suspended',\n\n  /** User has been permanently banned from the platform. */\n  Banned: 'banned',\n} as const;\n\n/**\n * Enum representing the supported authentication providers for user login.\n * @description Auth Providers allowed such as Email, Wallet, etc.\n *\n * @example\n * ```typescript\n * import { AUTH_PROVIDER } from '@plyaz/types';\n *\n * const provider = AUTH_PROVIDER.Wallet; // 'wallet'\n * const isWeb3Auth = provider === AUTH_PROVIDER.Wallet;\n * ```\n */\nexport const AUTH_PROVIDER = {\n  /** Authentication via email and password. */\n  Email: 'email',\n\n  /** Authentication via connected blockchain wallet. */\n  Wallet: 'wallet',\n} as const;\n\nexport enum AUTH_PROVIDER_TYPE {\n  ClerkSupabase = 'CLERK_SUPABASE',\n  InternalDb = 'INTERNAL_DB',\n}\n","import { z } from 'zod';\n\n/**\n * Zod schema for validating user login credentials.\n * @description Ensures the input object contains a valid email address and a password string.\n * @example\n * ```ts\n * LoginCredentialsSchema.parse({\n *   email: \"user@example.com\",\n *   password: \"\"\n * });\n * ```\n */\nexport const loginCredentialsSchema = z.object({\n  // The user's email address. Must be a valid email format.\n  email: z.string().email('Invalid email format'),\n\n  // The user's password. No format constraints applied here.\n  password: z.string(),\n});\n\n/**\n * Type inferred from {@link loginCredentialsSchema}.\n * @description Represents the shape of validated login credentials input.\n */\nexport type LoginCredentialsInput = z.infer<typeof loginCredentialsSchema>;\n"]}
+{"version":3,"sources":["../../src/auth/enums.ts","../../src/auth/schemas.ts"],"names":["AUTH_PROVIDER_TYPE"],"mappings":";;;;;AAYO,IAAM,SAAA,GAAY;AAAA;AAAA,EAEvB,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,IAAA,EAAM,MAAA;AAAA;AAAA,EAGN,GAAA,EAAK,KAAA;AAAA;AAAA,EAGL,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,UAAA,EAAY;AACd;AAcO,IAAM,WAAA,GAAc;AAAA;AAAA,EAEzB,MAAA,EAAQ,QAAA;AAAA;AAAA,EAGR,QAAA,EAAU,UAAA;AAAA;AAAA,EAGV,OAAA,EAAS,SAAA;AAAA;AAAA,EAGT,SAAA,EAAW,WAAA;AAAA;AAAA,EAGX,MAAA,EAAQ;AACV;AAcO,IAAM,aAAA,GAAgB;AAAA;AAAA,EAE3B,KAAA,EAAO,OAAA;AAAA;AAAA,EAGP,MAAA,EAAQ;AACV;AAEO,IAAK,kBAAA,qBAAAA,mBAAAA,KAAL;AACL,EAAAA,oBAAA,eAAA,CAAA,GAAgB,gBAAA;AAChB,EAAAA,oBAAA,YAAA,CAAA,GAAa,aAAA;AAFH,EAAA,OAAAA,mBAAAA;AAAA,CAAA,EAAA,kBAAA,IAAA,EAAA;AC/EZ,IAAM,gBAAA,GAAmB,CAAA;AAMlB,IAAM,mBAAA,GAAsB,EAAE,MAAA,CAAO;AAAA,EAC1C,IAAA,EAAM,CAAA,CAAE,MAAA,CAAO,EAAE,KAAA,EAAO,4BAA4B,CAAA,CAAE,GAAA,CAAI,CAAA,EAAG,yBAAyB,CAAA;AAAA,EACtF,OAAO,CAAA,CAAE,KAAA,CAAM,EAAE,KAAA,EAAO,4BAA4B;AACtD,CAAC;AAWM,IAAM,gBAAA,GAAmB,EAAE,MAAA,CAAO;AAAA,EACvC,IAAA,EAAM,CAAA,CAAE,MAAA,CAAO,EAAE,KAAA,EAAO,4BAA4B,CAAA,CAAE,GAAA,CAAI,CAAA,EAAG,yBAAyB,CAAA;AAAA,EACtF,OAAO,CAAA,CAAE,KAAA,CAAM,EAAE,KAAA,EAAO,4BAA4B,CAAA;AAAA,EACpD,QAAA,EAAU,CAAA,CACP,MAAA,CAAO,EAAE,KAAA,EAAO,4BAA4B,CAAA,CAC5C,GAAA,CAAI,gBAAA,EAAkB,8BAA8B;AACzD,CAAC","file":"index.js","sourcesContent":["/**\n * Enum representing the different roles a user can have within the system.\n * @description Roles are used to determine access levels, permissions, and user-specific experiences.\n *\n * @example\n * ```typescript\n * import { USER_ROLE } from '@plyaz/types';\n *\n * const userRole = USER_ROLE.Athlete; // 'athlete'\n * const isAdmin = userRole === USER_ROLE.Admin || userRole === USER_ROLE.SuperAdmin;\n * ```\n */\nexport const USER_ROLE = {\n  /** A user who is an athlete and participates in sports activities. */\n  Athlete: 'athlete',\n\n  /** A user who scouts and discovers talent. */\n  Scout: 'scout',\n\n  /** A user who acts as an agent representing athletes or clubs. */\n  Agent: 'agent',\n\n  /** A user representing a sports club or organization. */\n  Club: 'club',\n\n  /** A fan or supporter of athletes or clubs. */\n  Fan: 'fan',\n\n  /** A system administrator with access to management tools. */\n  Admin: 'admin',\n\n  /** A super admin with the highest level of access and control. */\n  SuperAdmin: 'super.admin',\n} as const;\n\n/**\n * Enum representing the current status of a user account.\n * @description Statuses are used to determine login availability, visibility, and user flow.\n *\n * @example\n * ```typescript\n * import { USER_STATUS } from '@plyaz/types';\n *\n * const isAccessible = status === USER_STATUS.Active;\n * const needsReview = status === USER_STATUS.Pending;\n * ```\n */\nexport const USER_STATUS = {\n  /** Active user with full access. */\n  Active: 'active',\n\n  /** Inactive user, typically not currently using the platform. */\n  Inactive: 'inactive',\n\n  /** User account is awaiting approval or completion of setup. */\n  Pending: 'pending',\n\n  /** User has been temporarily suspended due to policy violations or manual review. */\n  Suspended: 'suspended',\n\n  /** User has been permanently banned from the platform. */\n  Banned: 'banned',\n} as const;\n\n/**\n * Enum representing the supported authentication providers for user login.\n * @description Auth Providers allowed such as Email, Wallet, etc.\n *\n * @example\n * ```typescript\n * import { AUTH_PROVIDER } from '@plyaz/types';\n *\n * const provider = AUTH_PROVIDER.Wallet; // 'wallet'\n * const isWeb3Auth = provider === AUTH_PROVIDER.Wallet;\n * ```\n */\nexport const AUTH_PROVIDER = {\n  /** Authentication via email and password. */\n  Email: 'email',\n\n  /** Authentication via connected blockchain wallet. */\n  Wallet: 'wallet',\n} as const;\n\nexport enum AUTH_PROVIDER_TYPE {\n  ClerkSupabase = 'CLERK_SUPABASE',\n  InternalDb = 'INTERNAL_DB',\n}\n","import { z } from 'zod';\n\n/**\n * Password minimum character length\n */\nconst DEFAULT_PASSWORD = 8;\n\n/**\n * Contact Us Form Schema\n * Validates contact form submissions\n */\nexport const ContactUsFormSchema = z.object({\n  name: z.string({ error: 'errors.form.missingField' }).min(1, 'errors.form.nameMissing'),\n  email: z.email({ error: 'errors.form.emailInvalid' }),\n});\n\n/**\n * Contact Us Form Type\n */\nexport type ContactUsForm = z.infer<typeof ContactUsFormSchema>;\n\n/**\n * Signup Form Schema\n * Validates user registration form submissions\n */\nexport const SignupFormSchema = z.object({\n  name: z.string({ error: 'errors.form.missingField' }).min(1, 'errors.form.nameMissing'),\n  email: z.email({ error: 'errors.form.emailInvalid' }),\n  password: z\n    .string({ error: 'errors.form.missingField' })\n    .min(DEFAULT_PASSWORD, 'errors.form.passwordTooShort'),\n});\n\n/**\n * Signup Form Type\n */\nexport type SignupForm = z.infer<typeof SignupFormSchema>;\n"]}

package/dist/auth/schemas.d.ts

@@ -1,27 +1,26 @@
 import { z } from 'zod';
 /**
- * Zod schema for validating user login credentials.
- * @description Ensures the input object contains a valid email address and a password string.
- * @example
- * ```ts
- * LoginCredentialsSchema.parse({
- *   email: "user@example.com",
- *   password: ""
- * });
- * ```
+ * Contact Us Form Schema
+ * Validates contact form submissions
  */
-export declare const loginCredentialsSchema: z.ZodObject<{
-    email: z.ZodString;
+export declare const ContactUsFormSchema: z.ZodObject<{
+    name: z.ZodString;
+    email: z.ZodEmail;
+}, z.core.$strip>;
+/**
+ * Contact Us Form Type
+ */
+export type ContactUsForm = z.infer<typeof ContactUsFormSchema>;
+/**
+ * Signup Form Schema
+ * Validates user registration form submissions
+ */
+export declare const SignupFormSchema: z.ZodObject<{
+    name: z.ZodString;
+    email: z.ZodEmail;
     password: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    email?: string;
-    password?: string;
-}, {
-    email?: string;
-    password?: string;
-}>;
+}, z.core.$strip>;
 /**
- * Type inferred from {@link loginCredentialsSchema}.
- * @description Represents the shape of validated login credentials input.
+ * Signup Form Type
  */
-export type LoginCredentialsInput = z.infer<typeof loginCredentialsSchema>;
+export type SignupForm = z.infer<typeof SignupFormSchema>;

package/dist/errors/types.d.ts

@@ -306,7 +306,7 @@ export interface PackageErrorLike extends Error {
     /** Convert error to string representation */
     toString(): string;
     /** Get user-friendly message for display to end users */
-    getUserMessage(): string;
+    getUserMessage(locale?: string): string;
 }
 export type AsyncMiddleware<TReturn = void> = (req: Request, res: Response, next: NextFunction) => Promise<TReturn>;
 export type MiddlewareWrapper = <TReturn>(fn: AsyncMiddleware<TReturn>) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
@@ -531,9 +531,10 @@ export interface ApiPackageErrorOptions<TEndpoints = unknown, TClient = ApiClien
     metadata?: Record<string, string | number | boolean | null>;
 }
 /**
- * Configuration for ApiPackageError class
+ * Generic configuration for package error classes
+ * Used by all @plyaz packages (api, notifications, errors, etc.)
  */
-export interface ApiPackageErrorConfig {
+export interface PackageErrorConfig {
     /** Package namespace for event emission */
     namespace?: string;
     /** Event factory for scoped events */
@@ -697,3 +698,41 @@ export type StatusCodeValue = number | InternalStatusCodeValue;
 export interface I18nContext {
     [key: string]: string | number | boolean | null | undefined;
 }
+/**
+ * ===== Sanitization Configuration =====
+ */
+/**
+ * Configuration for value sanitization in error messages
+ * Used to prevent injection attacks when interpolating values into error messages
+ *
+ * @example
+ * ```typescript
+ * const config: SanitizeConfig = {
+ *   maxLength: 500,
+ *   stripHtml: true,
+ *   escapeNewlines: true
+ * };
+ * ```
+ */
+export interface SanitizeConfig {
+    /**
+     * Maximum length for interpolated string values
+     * @default 1000
+     */
+    maxLength?: number;
+    /**
+     * Whether to strip all HTML tags
+     * @default true
+     */
+    stripHtml?: boolean;
+    /**
+     * Whether to escape newlines to prevent log injection
+     * @default true
+     */
+    escapeNewlines?: boolean;
+    /**
+     * Whether to limit object/array string representation
+     * @default true
+     */
+    limitComplexTypes?: boolean;
+}