@getpara/user-management-client 0.1.0

package/dist/types/types/auth.d.ts

@@ -0,0 +1,86 @@
+export type AuthType = 'email' | 'phone' | 'farcaster' | 'telegram' | 'userId';
+export type $ExtractAuth<T extends AuthType> = {
+    auth: Auth<T>;
+    authType: T;
+    identifier: string;
+    publicKeyIdentifier: string;
+};
+export type ExtractAuth = $ExtractAuth<'email'> | $ExtractAuth<'phone'> | $ExtractAuth<'farcaster'> | $ExtractAuth<'telegram'> | $ExtractAuth<'userId'>;
+export type AuthParams = Record<string, any> & {
+    email?: string;
+    phone?: string;
+    countryCode?: string;
+    farcasterUsername?: string;
+    telegramUserId?: string;
+    userId?: string;
+};
+export type Auth<T extends AuthType = AuthType> = T extends 'email' ? {
+    email: string;
+} : T extends 'phone' ? {
+    phone: string;
+    countryCode: string;
+} : T extends 'farcaster' ? {
+    farcasterUsername: string;
+} : T extends 'telegram' ? {
+    telegramUserId: string;
+} : {
+    userId: string;
+};
+export declare enum EncryptorType {
+    USER = "USER",
+    RECOVERY = "RECOVERY",
+    BIOMETRICS = "BIOMETRICS",
+    PASSWORD = "PASSWORD"
+}
+export declare enum KeyShareType {
+    USER = "USER",
+    RECOVERY = "RECOVERY"
+}
+export declare enum PasswordStatus {
+    PENDING = "PENDING",
+    COMPLETE = "COMPLETE"
+}
+export declare enum PublicKeyStatus {
+    PENDING = "PENDING",
+    COMPLETE = "COMPLETE"
+}
+export declare enum PublicKeyType {
+    MOBILE = "MOBILE",
+    WEB = "WEB"
+}
+export interface EncryptedKeyShare {
+    encryptedShare: string;
+    encryptedKey?: string;
+    type: KeyShareType;
+    biometricPublicKey?: string;
+    encryptor: EncryptorType;
+    recoveryPublicKeyId?: string;
+    partnerId?: string;
+    protocolId?: string;
+}
+export declare enum OAuthMethod {
+    GOOGLE = "GOOGLE",
+    TWITTER = "TWITTER",
+    APPLE = "APPLE",
+    DISCORD = "DISCORD",
+    FACEBOOK = "FACEBOOK",
+    FARCASTER = "FARCASTER",
+    TELEGRAM = "TELEGRAM"
+}
+export declare enum AuthMethod {
+    PASSWORD = "PASSWORD",
+    PASSKEY = "PASSKEY"
+}
+export type BiometricLocationHint = {
+    useragent?: string;
+    aaguid?: string;
+};
+export type TelegramAuthResponse = {
+    auth_date: number;
+    first_name?: string;
+    hash: string;
+    id: number;
+    last_name?: string;
+    photo_url?: string;
+    username?: string;
+};

package/dist/types/types/email.d.ts

@@ -0,0 +1,22 @@
+export declare enum EmailTheme {
+    LIGHT = "light",
+    DARK = "dark"
+}
+export interface VerificationEmailProps {
+    theme?: EmailTheme;
+    homepageUrl?: string;
+    xUrl?: string;
+    linkedinUrl?: string;
+    githubUrl?: string;
+    supportUrl?: string;
+    brandColor?: string;
+}
+export interface BackupKitEmailProps {
+    theme?: EmailTheme;
+    homepageUrl?: string;
+    xUrl?: string;
+    linkedinUrl?: string;
+    githubUrl?: string;
+    supportUrl?: string;
+    brandColor?: string;
+}

package/dist/types/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from './auth.js';
+export * from './email.js';
+export * from './onRamp.js';
+export * from './partner.js';
+export * from './wallet.js';

package/dist/types/types/onRamp.d.ts

@@ -0,0 +1,68 @@
+import { Network, WalletType } from './wallet.js';
+export declare enum OnRampProvider {
+    RAMP = "RAMP",
+    STRIPE = "STRIPE",
+    MOONPAY = "MOONPAY"
+}
+export declare enum OnRampAsset {
+    ETHEREUM = "ETHEREUM",
+    USDC = "USDC",
+    TETHER = "TETHER",
+    POLYGON = "POLYGON",
+    SOLANA = "SOLANA",
+    ATOM = "ATOM",
+    CELO = "CELO",
+    CUSD = "CUSD",
+    CEUR = "CEUR",
+    CREAL = "CREAL"
+}
+export declare enum OnRampPurchaseStatus {
+    INITIATED = "INITIATED",
+    FINISHED = "FINISHED",
+    CANCELLED = "CANCELLED"
+}
+export declare enum OnRampPurchaseType {
+    BUY = "BUY",
+    SELL = "SELL"
+}
+export interface OnRampPurchase {
+    id: string;
+    userId: string;
+    type?: OnRampPurchaseType;
+    walletId?: string | null;
+    walletType?: WalletType;
+    externalWalletAddress?: string | null;
+    address?: string | null;
+    status?: OnRampPurchaseStatus;
+    provider?: OnRampProvider;
+    providerKey?: string | null;
+    fiat?: string | null;
+    fiatQuantity?: string | null;
+    asset?: OnRampAsset;
+    assetQuantity?: string | null;
+    network?: Network | null;
+    testMode?: boolean;
+}
+export type OnRampPurchaseCreateParams = Omit<OnRampPurchase, 'id' | 'userId'> & {
+    networks?: Network[] | 'all';
+    assets?: OnRampAsset[] | 'all';
+    defaultNetwork?: Network;
+    defaultAsset?: OnRampAsset;
+};
+export type OnRampPurchaseUpdateParams = Omit<OnRampPurchase, 'id' | 'userId'>;
+type ProviderAssetInfo = [string, Partial<Record<OnRampPurchaseType, boolean>>];
+export type OnRampAssetInfo = Record<WalletType, Partial<Record<Network, Partial<Record<OnRampAsset, Partial<Record<OnRampProvider, ProviderAssetInfo>>>>>>>;
+export type OnRampAllowedAssets = Partial<Record<Network, true | OnRampAsset[]>>;
+export type OnRampConfig = {
+    isBuyEnabled: boolean;
+    isReceiveEnabled: boolean;
+    isWithdrawEnabled: boolean;
+    assetInfo: OnRampAssetInfo;
+    providers: OnRampProvider[];
+    allowedAssets?: OnRampAllowedAssets;
+    rampApiKey?: string;
+    defaultOnRampAsset?: OnRampAsset;
+    defaultOnRampNetwork?: Network;
+    defaultBuyAmount?: [string, string];
+};
+export {};

package/dist/types/types/partner.d.ts

@@ -0,0 +1,13 @@
+export interface PartnerEntity {
+    id: string;
+    displayName: string;
+    logoUrl?: string;
+    iconUrl?: string;
+    portalHeaderLogoUrl?: string;
+    policiesEnabled: boolean;
+    backgroundColor?: string;
+    foregroundColor?: string;
+    accentColor?: string;
+    font?: string;
+    themeMode?: 'light' | 'dark';
+}

package/dist/types/types/wallet.d.ts

@@ -0,0 +1,59 @@
+import { OAuthMethod } from './auth.js';
+import { PartnerEntity } from './partner.js';
+export declare enum WalletScheme {
+    DKLS = "DKLS",
+    CGGMP = "CGGMP",
+    ED25519 = "ED25519"
+}
+export declare enum WalletType {
+    EVM = "EVM",
+    SOLANA = "SOLANA",
+    COSMOS = "COSMOS"
+}
+export declare enum Chain {
+    ETH = "ETH",
+    CELO = "CELO",
+    MATIC = "MATIC"
+}
+export declare enum Network {
+    ETHEREUM = "ETHEREUM",
+    SEPOLIA = "SEPOLIA",
+    ARBITRUM = "ARBITRUM",
+    BASE = "BASE",
+    OPTIMISM = "OPTIMISM",
+    POLYGON = "POLYGON",
+    SOLANA = "SOLANA",
+    COSMOS = "COSMOS",
+    CELO = "CELO",
+    NOBLE = "NOBLE"
+}
+export type WalletRef = 'walletId' | 'externalWalletAddress';
+export type WalletParams = Partial<{
+    walletId?: string;
+    externalWalletAddress?: string;
+}>;
+export declare const PREGEN_IDENTIFIER_TYPES: readonly ["EMAIL", "PHONE", "CUSTOM_ID", OAuthMethod.DISCORD, OAuthMethod.TWITTER, OAuthMethod.TELEGRAM];
+export type TPregenIdentifierType = (typeof PREGEN_IDENTIFIER_TYPES)[number];
+export type PregenIds = Partial<Record<TPregenIdentifierType, string[]>>;
+export interface WalletEntity {
+    address: string | null;
+    createdAt: string;
+    isPregen?: boolean;
+    pregenIdentifier: string;
+    pregenIdentifierType: TPregenIdentifierType;
+    id: string;
+    keyGenComplete: boolean;
+    name: string | null;
+    partnerId: string;
+    partner?: PartnerEntity;
+    publicKey: string | null;
+    scheme: string;
+    type: WalletType;
+    updatedAt: string;
+    userId: string | null;
+    lastUsedAt: string | null;
+    lastUsedPartnerId?: string;
+    lastUsedPartner?: PartnerEntity;
+}
+export type CurrentWalletIds = Partial<Record<WalletType, string[]>>;
+export declare const NON_ED25519: WalletScheme[];

package/dist/types/utils.d.ts

@@ -0,0 +1,19 @@
+import { Auth, AuthParams, ExtractAuth, WalletParams, WalletRef } from './types/index.js';
+export declare function isWalletId(params: WalletParams): params is {
+    walletId: string;
+};
+export declare function isExternalWalletAddress(params: WalletParams): params is {
+    externalWalletAddress: string;
+};
+export declare function extractWalletRef(params: WalletParams): [WalletRef, string];
+export declare function isEmail(params: AuthParams): params is Auth<'email'>;
+export declare function isPhone(params: AuthParams): params is Auth<'phone'>;
+export declare function isFarcaster(params: AuthParams): params is Auth<'farcaster'>;
+export declare function isTelegram(params: AuthParams): params is Auth<'telegram'>;
+export declare function isUserId(params: AuthParams): params is Auth<'userId'>;
+export declare function extractAuthInfo(obj: AuthParams, { allowUserId }?: {
+    allowUserId?: boolean;
+}): ExtractAuth;
+export declare function extractAuth(obj: AuthParams, opts?: Parameters<typeof extractAuthInfo>[1] & {
+    optional?: boolean;
+}): Auth | undefined;

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@getpara/user-management-client",
+  "version": "0.1.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "typings": "dist/types/index.d.ts",
+  "sideEffects": false,
+  "scripts": {
+    "build": "yarn build:cjs && yarn build:esm && yarn build:types",
+    "build:cjs": "rm -rf dist/cjs && tsc --module commonjs --outDir dist/cjs && printf '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
+    "build:esm": "rm -rf dist/esm && tsc --module es6 --outDir dist/esm && printf '{\"type\":\"module\",\"sideEffects\":false}' > dist/esm/package.json",
+    "build:types": "rm -rf dist/types && tsc --module es6 --declarationDir dist/types --emitDeclarationOnly --declaration",
+    "test": "vitest run --coverage"
+  },
+  "dependencies": {
+    "axios": "^1.6.3",
+    "libphonenumber-js": "1.11.2",
+    "qs": "^6.12.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.4"
+  },
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "gitHead": "625aaa94001a5461dcde8d6775c3b73f3862c76c"
+}