@plyaz/types 1.12.0 → 1.12.1

package/dist/auth/index.d.ts

@@ -1,4 +1,3 @@
 export * from './enums';
 export * from './schemas';
 export type * from './types';
-export type * from './config';

package/dist/auth/index.js

@@ -37,6 +37,11 @@ var AUTH_PROVIDER = {
   /** Authentication via connected blockchain wallet. */
   Wallet: "wallet"
 };
+var AUTH_PROVIDER_TYPE = /* @__PURE__ */ ((AUTH_PROVIDER_TYPE2) => {
+  AUTH_PROVIDER_TYPE2["ClerkSupabase"] = "CLERK_SUPABASE";
+  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"),
@@ -44,6 +49,6 @@ var loginCredentialsSchema = z.object({
   password: z.string()
 });
 
-export { AUTH_PROVIDER, USER_ROLE, USER_STATUS, loginCredentialsSchema };
+export { AUTH_PROVIDER, AUTH_PROVIDER_TYPE, USER_ROLE, USER_STATUS, loginCredentialsSchema };
 //# 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":[],"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;ACrEO,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","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;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"]}

package/dist/auth/types.d.ts

@@ -28,3 +28,37 @@ export type UserContext = {
     email: string;
     createdAt: Date;
 };
+/**
+ * @fileoverview Defines the contract for all authentication service providers
+ * responsible for handling the synchronization between an external identity
+ * source (like Clerk, Auth0, etc.) and the internal database user structure.
+ *
+ * Any provider implementing this interface must handle user lookup, creation,
+ * and issuance of the necessary internal tokens (like the Supabase RLS JWT).
+ */
+export interface AuthServiceProvider {
+    /**
+     * Synchronizes an external user's identity with the internal application database.
+     *
+     * This is typically called immediately after a successful authentication with
+     * an external provider to ensure the user exists in the local database,
+     * update their metadata, and issue an internal authorization token (e.g., RLS JWT).
+     *
+     * @param externalId The unique identifier from the external authentication provider (e.g., Clerk's 'sub').
+     * @param email The user's primary email address from the external provider.
+     * @returns A Promise resolving to an object containing the internal UserContext and the provider-specific RLS JWT.
+     */
+    syncUserFromExternalToken(externalId: string, email: string): Promise<{
+        user: UserContext;
+        supabaseRlsToken: string;
+    }>;
+    /**
+     * Retrieves a user's context from the internal database using their internal ID.
+     *
+     * This method is generally used by trusted backend services and must bypass RLS.
+     *
+     * @param userId The internal database UUID of the user.
+     * @returns A Promise resolving to the user's basic context (`UserContext`) or `null` if not found.
+     */
+    getUserById(userId: string): Promise<UserContext | null>;
+}

package/dist/index.cjs

@@ -43,6 +43,11 @@ var AUTH_PROVIDER = {
   /** Authentication via connected blockchain wallet. */
   Wallet: "wallet"
 };
+var AUTH_PROVIDER_TYPE = /* @__PURE__ */ ((AUTH_PROVIDER_TYPE2) => {
+  AUTH_PROVIDER_TYPE2["ClerkSupabase"] = "CLERK_SUPABASE";
+  AUTH_PROVIDER_TYPE2["InternalDb"] = "INTERNAL_DB";
+  return AUTH_PROVIDER_TYPE2;
+})(AUTH_PROVIDER_TYPE || {});
 
 // node_modules/.pnpm/zod@3.25.76/node_modules/zod/v3/external.js
 var external_exports = {};
@@ -4505,7 +4510,7 @@ var ALL_EVENTS = {
   ...CACHE_EVENTS
 };
 
-// node_modules/.pnpm/@plyaz+config@1.6.3_next@15.4.7_react-dom@19.2.0_react@19.2.0_typescript@5.9.3_zod@3.25.76/node_modules/@plyaz/config/dist/index.mjs
+// node_modules/.pnpm/@plyaz+config@1.6.4_next@15.4.7_react-dom@19.2.0_react@19.2.0_typescript@5.9.3_zod@3.25.76/node_modules/@plyaz/config/dist/index.mjs
 globalThis.process.env.NODE_ENV === "development";
 globalThis.process.env.NODE_ENV === "production";
 globalThis.process.env.NODE_ENV === "test";
@@ -5690,6 +5695,7 @@ exports.ALERT_TYPES = ALERT_TYPES;
 exports.ALL_EVENTS = ALL_EVENTS;
 exports.API_ERROR_CODES = API_ERROR_CODES;
 exports.AUTH_PROVIDER = AUTH_PROVIDER;
+exports.AUTH_PROVIDER_TYPE = AUTH_PROVIDER_TYPE;
 exports.CACHE_DURATION_MS = CACHE_DURATION_MS;
 exports.CACHE_EVENTS = CACHE_EVENTS;
 exports.CHAIN_ID = CHAIN_ID;