@planetlogin/core 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -6,6 +6,8 @@ interface Locale {
     language?: string;
     timezone?: string;
     country?: string;
+    lat?: number;
+    lon?: number;
 }
 interface SessionClaims {
     sub: string;
@@ -41,6 +43,13 @@ interface DownstreamUser {
     locale?: Locale;
     totpEnabled?: boolean;
 }
+/** Per-user, dev-owned preferences (spec §4). `locale` is the typed, first-class
+ *  piece PlanetLogin reads/writes (fly-to + i18n); `data` is an open bag the
+ *  integrator can store any "that kind of info" in. */
+interface UserPreferences {
+    locale?: Locale;
+    data?: Record<string, unknown>;
+}
 declare class Downstream {
     private baseUrl;
     private secret;
@@ -86,6 +95,13 @@ declare class Downstream {
         secret: string;
         enabled: boolean;
     }): Promise<unknown>;
+    /** Preferences (spec §4): per-user locale + open data bag. Null when none. */
+    preferencesGet(query: {
+        userId: string;
+    }): Promise<UserPreferences | null>;
+    preferencesSave(data: {
+        userId: string;
+    } & UserPreferences): Promise<unknown>;
 }
 
 interface PlanetLoginConfig {
@@ -127,6 +143,10 @@ interface PlanetLoginConfig {
         showSearch?: boolean;
         autoSpin?: boolean;
     };
+    locale?: {
+        persist?: boolean;
+        flyToOnLogin?: boolean;
+    };
     token?: {
         issuer?: string;
         audience?: string;
@@ -198,6 +218,9 @@ declare function publicConfig(c?: PlanetLoginConfig): {
         showSearch?: boolean;
         autoSpin?: boolean;
     };
+    locale: {
+        flyToOnLogin: boolean;
+    };
 };
 declare function downstreamFromEnv(): Downstream;
 
@@ -427,6 +450,24 @@ type PasswordLoginResult = {
 };
 declare function passwordLogin(deps: PasswordLoginDeps, input: PasswordLoginInput): Promise<PasswordLoginResult>;
 
+interface PreferencesDeps {
+    downstream: Pick<Downstream, 'preferencesGet' | 'preferencesSave'>;
+}
+/** Keep only the known, well-typed locale fields (drop anything else). */
+declare function sanitizeLocale(input: unknown): Locale | undefined;
+/** Read the user's saved preferences. Always resolves (empty object if none/error). */
+declare function getPreferences(deps: PreferencesDeps, input: {
+    userId: string;
+}): Promise<UserPreferences>;
+/** Write the user's preferences. No-op when there's nothing valid to write. */
+declare function savePreferences(deps: PreferencesDeps, input: {
+    userId: string;
+    locale?: unknown;
+    data?: unknown;
+}): Promise<{
+    saved: boolean;
+}>;
+
 interface MagicRequestDeps {
     downstream: Downstream;
     signMagicToken: (identifier: string) => Promise<string>;
@@ -570,4 +611,4 @@ declare function totpVerify(deps: TotpDeps, input: {
     ok: boolean;
 }>;
 
-export { type AuthResult, type AuthVerifyDeps, type CorsConfig, DEFAULT_RULES, Downstream, type DownstreamUser, type JwtAlg, type Locale, type MagicRequestDeps, type MagicVerifyDeps, type MagicVerifyResult, type OAuthLoginDeps, type OAuthLoginInput, type OAuthLoginResult, type OAuthStateData, type PasswordLoginDeps, type PasswordLoginInput, type PasswordLoginResult, type PlanetLoginConfig, type ProviderConfig, type RateLimitDecision, type RateLimitRule, type RegisterResult, type RegisterVerifyDeps, type SessionClaims, type SessionStore, type StoreKind, type StoredCredential, type TotpDeps, _stores, authenticationOptions, buildAuthUrl, corsFromEnv, corsHeaders, downstreamFromEnv, exchangeCode, fetchProfile, getProvider, getStore, hashPassword, isPreflight, jwks, loadConfig, newTotpSecret, oauthCallback, oauthStart, openEnc, openOAuthState, originAllowed, passkeyAuthVerify, passkeyRegisterVerify, passwordLogin, pkcePair, publicConfig, rateLimit, registrationOptions, requestMagicLink, rlKey, ruleFor, sealEnc, sealOAuthState, signMagicToken, signSession, totpEnroll, totpKeyUri, totpVerify, verifyAuthentication, verifyMagicLink, verifyMagicToken, verifyPassword, verifyRegistration, verifySession, verifyTotp };
+export { type AuthResult, type AuthVerifyDeps, type CorsConfig, DEFAULT_RULES, Downstream, type DownstreamUser, type JwtAlg, type Locale, type MagicRequestDeps, type MagicVerifyDeps, type MagicVerifyResult, type OAuthLoginDeps, type OAuthLoginInput, type OAuthLoginResult, type OAuthStateData, type PasswordLoginDeps, type PasswordLoginInput, type PasswordLoginResult, type PlanetLoginConfig, type PreferencesDeps, type ProviderConfig, type RateLimitDecision, type RateLimitRule, type RegisterResult, type RegisterVerifyDeps, type SessionClaims, type SessionStore, type StoreKind, type StoredCredential, type TotpDeps, type UserPreferences, _stores, authenticationOptions, buildAuthUrl, corsFromEnv, corsHeaders, downstreamFromEnv, exchangeCode, fetchProfile, getPreferences, getProvider, getStore, hashPassword, isPreflight, jwks, loadConfig, newTotpSecret, oauthCallback, oauthStart, openEnc, openOAuthState, originAllowed, passkeyAuthVerify, passkeyRegisterVerify, passwordLogin, pkcePair, publicConfig, rateLimit, registrationOptions, requestMagicLink, rlKey, ruleFor, sanitizeLocale, savePreferences, sealEnc, sealOAuthState, signMagicToken, signSession, totpEnroll, totpKeyUri, totpVerify, verifyAuthentication, verifyMagicLink, verifyMagicToken, verifyPassword, verifyRegistration, verifySession, verifyTotp };

package/dist/index.js

@@ -55,6 +55,13 @@ var Downstream = class {
   totpSave(data) {
     return this.call("/totp/save", data);
   }
+  /** Preferences (spec §4): per-user locale + open data bag. Null when none. */
+  preferencesGet(query) {
+    return this.call("/preferences/find", query);
+  }
+  preferencesSave(data) {
+    return this.call("/preferences/save", data);
+  }
 };
 
 // src/config.ts
@@ -71,7 +78,15 @@ function loadConfig() {
   return cfg;
 }
 function publicConfig(c = loadConfig()) {
-  return { spec: c.spec, brand: c.brand, providers: c.providers, copy: c.copy ?? {}, layout: c.layout ?? {} };
+  return {
+    spec: c.spec,
+    brand: c.brand,
+    providers: c.providers,
+    copy: c.copy ?? {},
+    layout: c.layout ?? {},
+    // Only the client-relevant gate (flyToOnLogin drives the post-login fly-to).
+    locale: { flyToOnLogin: c.locale?.flyToOnLogin ?? false }
+  };
 }
 function downstreamFromEnv() {
   const url = process.env.PLANETLOGIN_DOWNSTREAM_URL;
@@ -557,6 +572,30 @@ async function passwordLogin(deps, input) {
   return { ok: true, token, user: { id: user.id, email: user.email, name: user.name } };
 }
 
+// src/flows/preferences.ts
+function sanitizeLocale(input) {
+  if (!input || typeof input !== "object") return void 0;
+  const i = input;
+  const out = {};
+  if (typeof i.language === "string") out.language = i.language.slice(0, 16);
+  if (typeof i.timezone === "string") out.timezone = i.timezone.slice(0, 64);
+  if (typeof i.country === "string") out.country = i.country.slice(0, 2).toUpperCase();
+  if (typeof i.lat === "number" && Number.isFinite(i.lat)) out.lat = i.lat;
+  if (typeof i.lon === "number" && Number.isFinite(i.lon)) out.lon = i.lon;
+  return Object.keys(out).length ? out : void 0;
+}
+async function getPreferences(deps, input) {
+  const p = await deps.downstream.preferencesGet({ userId: input.userId }).catch(() => null);
+  return p ?? {};
+}
+async function savePreferences(deps, input) {
+  const locale = sanitizeLocale(input.locale);
+  const data = input.data && typeof input.data === "object" && !Array.isArray(input.data) ? input.data : void 0;
+  if (!locale && !data) return { saved: false };
+  await deps.downstream.preferencesSave({ userId: input.userId, ...locale ? { locale } : {}, ...data ? { data } : {} });
+  return { saved: true };
+}
+
 // src/flows/magicLink.ts
 async function requestMagicLink(deps, input) {
   try {
@@ -675,6 +714,7 @@ export {
   downstreamFromEnv,
   exchangeCode,
   fetchProfile,
+  getPreferences,
   getProvider,
   getStore,
   hashPassword,
@@ -697,6 +737,8 @@ export {
   requestMagicLink,
   rlKey,
   ruleFor,
+  sanitizeLocale,
+  savePreferences,
   sealEnc,
   sealOAuthState,
   signMagicToken,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planetlogin/core",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "type": "module",
   "description": "PlanetLogin auth core — framework-agnostic flows, JWT, crypto, downstream contract. Consumed by every flavor; the HTTP binding stays per-framework.",
   "exports": {