@tastic/profile 0.1.3 → 0.3.1

package/README.md

@@ -54,6 +54,38 @@ see its own doc comment for why that component is generic over your own `Profile
   inline in the row you tap, with a destructive-delete confirmation. No navigation of its own (no
   router, no back button) — a host app renders this as a routed screen's body and supplies its own
   persistence via `profiles`/`onCreate`/`onSave`/`onDelete`.
+- **`loadSharedProfiles` / `saveSharedProfiles` / `isSharedProfileStoreAvailable`** — an *optional*
+  cross-app roster, shared between multiple apps of yours via a native iOS App Group (same Apple
+  Developer Team, same `"com.apple.security.application-groups"` entitlement value on every
+  participating app). This only ever carries the base `Profile` shape above — a host app's own
+  extension fields (a key scheme, a control scheme, anything else) are NOT part of it and have to
+  keep living in that app's own *local* storage, keyed by profile id, merged onto the shared base
+  roster at read time (falling back to some per-app default whenever a shared profile's id isn't
+  in that app's own local extension table yet — e.g. it was created on a different app in the
+  group). This split is deliberate, not a limitation to work around: it's this package's own
+  base-fields-only `Profile` boundary (see above), just applied to storage instead of just to the
+  TypeScript type.
+
+  ```ts
+  // App-side sketch — see BoxHockey's or LightCycles' own useProfiles.tsx for a full example.
+  const GROUP_ID = 'group.com.yourteam.yourgames'
+  const base = isSharedProfileStoreAvailable ? await loadSharedProfiles(GROUP_ID) : localBaseFallback
+  const profiles = base.map((p) => ({ ...p, controlScheme: localExtensions[p.id]?.controlScheme ?? DEFAULT_CONTROL_SCHEME }))
+  // ...on create/update/delete, write the base fields back with saveSharedProfiles(GROUP_ID, nextBase)
+  // and the extension field to the app's own local storage, same as today.
+  ```
+
+  Backed by a small native Expo Module (`ios/TasticProfileModule.swift`) wrapping
+  `UserDefaults(suiteName:)` — iOS only (see `expo-module.config.json`'s `"apple"`-only platform
+  list); `isSharedProfileStoreAvailable` is `false` on Android/web and on any iOS build that hasn't
+  run `expo prebuild` since adding this App Group's entitlement, so a host app always needs its own
+  local-storage fallback path regardless of platform. Requires the App Group itself to be declared
+  in each consuming app's own Expo config, e.g.:
+
+  ```json
+  // app.json
+  { "expo": { "ios": { "entitlements": { "com.apple.security.application-groups": ["group.com.yourteam.yourgames"] } } } }
+  ```
 
 ## Install (local dev via yalc)
 

package/dist/index.d.mts

@@ -55,4 +55,8 @@ declare const MAX_TAG_LENGTH = 3;
 declare function isValidTag(value: unknown): value is string;
 declare function isValidProfile(value: unknown): value is Profile;
 
-export { MAX_PROFILE_NAME_LENGTH, MAX_TAG_LENGTH, type Profile, ProfileChip, ProfilePicker, ProfilesManager, type ProfilesManagerProps, isValidProfile, isValidTag };
+declare const isSharedProfileStoreAvailable: boolean;
+declare function loadSharedProfiles(groupId: string): Promise<Profile[]>;
+declare function saveSharedProfiles(groupId: string, profiles: Profile[]): Promise<void>;
+
+export { MAX_PROFILE_NAME_LENGTH, MAX_TAG_LENGTH, type Profile, ProfileChip, ProfilePicker, ProfilesManager, type ProfilesManagerProps, isSharedProfileStoreAvailable, isValidProfile, isValidTag, loadSharedProfiles, saveSharedProfiles };

package/dist/index.d.ts

@@ -55,4 +55,8 @@ declare const MAX_TAG_LENGTH = 3;
 declare function isValidTag(value: unknown): value is string;
 declare function isValidProfile(value: unknown): value is Profile;
 
-export { MAX_PROFILE_NAME_LENGTH, MAX_TAG_LENGTH, type Profile, ProfileChip, ProfilePicker, ProfilesManager, type ProfilesManagerProps, isValidProfile, isValidTag };
+declare const isSharedProfileStoreAvailable: boolean;
+declare function loadSharedProfiles(groupId: string): Promise<Profile[]>;
+declare function saveSharedProfiles(groupId: string, profiles: Profile[]): Promise<void>;
+
+export { MAX_PROFILE_NAME_LENGTH, MAX_TAG_LENGTH, type Profile, ProfileChip, ProfilePicker, ProfilesManager, type ProfilesManagerProps, isSharedProfileStoreAvailable, isValidProfile, isValidTag, loadSharedProfiles, saveSharedProfiles };

package/dist/index.js

@@ -25,8 +25,11 @@ __export(index_exports, {
   ProfileChip: () => ProfileChip,
   ProfilePicker: () => ProfilePicker,
   ProfilesManager: () => ProfilesManager,
+  isSharedProfileStoreAvailable: () => isSharedProfileStoreAvailable,
   isValidProfile: () => isValidProfile,
-  isValidTag: () => isValidTag
+  isValidTag: () => isValidTag,
+  loadSharedProfiles: () => loadSharedProfiles,
+  saveSharedProfiles: () => saveSharedProfiles
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -503,6 +506,40 @@ var styles3 = import_react_native3.StyleSheet.create({
     fontWeight: "bold"
   }
 });
+
+// src/sharedProfileStore.ts
+var native = null;
+try {
+  const { requireOptionalNativeModule } = require("expo-modules-core");
+  native = requireOptionalNativeModule("TasticProfile") ?? null;
+} catch {
+  native = null;
+}
+var PROFILES_KEY = "sharedProfiles";
+var isSharedProfileStoreAvailable = native !== null;
+async function loadSharedProfiles(groupId) {
+  if (!native) return [];
+  let json = null;
+  try {
+    json = await native.getSharedJSON(groupId, PROFILES_KEY);
+  } catch {
+    return [];
+  }
+  if (!json) return [];
+  try {
+    const parsed = JSON.parse(json);
+    return Array.isArray(parsed) ? parsed.filter(isValidProfile) : [];
+  } catch {
+    return [];
+  }
+}
+async function saveSharedProfiles(groupId, profiles) {
+  if (!native) return;
+  try {
+    await native.setSharedJSON(groupId, PROFILES_KEY, JSON.stringify(profiles));
+  } catch {
+  }
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   MAX_PROFILE_NAME_LENGTH,
@@ -510,6 +547,9 @@ var styles3 = import_react_native3.StyleSheet.create({
   ProfileChip,
   ProfilePicker,
   ProfilesManager,
+  isSharedProfileStoreAvailable,
   isValidProfile,
-  isValidTag
+  isValidTag,
+  loadSharedProfiles,
+  saveSharedProfiles
 });

package/dist/index.mjs

@@ -1,3 +1,10 @@
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
 // src/ProfileChip.tsx
 import { getContrastColor } from "@rific/auto-paper";
 import { StyleSheet, View } from "react-native";
@@ -471,12 +478,49 @@ var styles3 = StyleSheet3.create({
     fontWeight: "bold"
   }
 });
+
+// src/sharedProfileStore.ts
+var native = null;
+try {
+  const { requireOptionalNativeModule } = __require("expo-modules-core");
+  native = requireOptionalNativeModule("TasticProfile") ?? null;
+} catch {
+  native = null;
+}
+var PROFILES_KEY = "sharedProfiles";
+var isSharedProfileStoreAvailable = native !== null;
+async function loadSharedProfiles(groupId) {
+  if (!native) return [];
+  let json = null;
+  try {
+    json = await native.getSharedJSON(groupId, PROFILES_KEY);
+  } catch {
+    return [];
+  }
+  if (!json) return [];
+  try {
+    const parsed = JSON.parse(json);
+    return Array.isArray(parsed) ? parsed.filter(isValidProfile) : [];
+  } catch {
+    return [];
+  }
+}
+async function saveSharedProfiles(groupId, profiles) {
+  if (!native) return;
+  try {
+    await native.setSharedJSON(groupId, PROFILES_KEY, JSON.stringify(profiles));
+  } catch {
+  }
+}
 export {
   MAX_PROFILE_NAME_LENGTH,
   MAX_TAG_LENGTH,
   ProfileChip,
   ProfilePicker,
   ProfilesManager,
+  isSharedProfileStoreAvailable,
   isValidProfile,
-  isValidTag
+  isValidTag,
+  loadSharedProfiles,
+  saveSharedProfiles
 };

package/expo-module.config.json

@@ -0,0 +1,6 @@
+{
+  "platforms": ["apple"],
+  "apple": {
+    "modules": ["TasticProfileModule"]
+  }
+}

package/ios/TasticProfile.podspec

@@ -0,0 +1,26 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, '..', 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name           = 'TasticProfile'
+  s.version        = package['version']
+  s.summary        = package['description']
+  s.description    = package['description']
+  s.license        = package['license']
+  s.author         = package['author']
+  s.homepage       = package['homepage']
+  s.platforms      = { :ios => '16.4' }
+  s.swift_version  = '5.9'
+  s.source         = { git: package['repository']['url'] }
+  s.static_framework = true
+
+  s.dependency 'ExpoModulesCore'
+
+  s.pod_target_xcconfig = {
+    'DEFINES_MODULE' => 'YES',
+    'SWIFT_COMPILATION_MODE' => 'wholemodule'
+  }
+
+  s.source_files = "**/*.{h,m,mm,swift,hpp,cpp}"
+end

package/ios/TasticProfileModule.swift

@@ -0,0 +1,22 @@
+import ExpoModulesCore
+
+// Generic group/key -> JSON-string bridge onto a native iOS App Group's shared UserDefaults suite
+// — the mechanism that actually lets two separate apps (same Apple Developer Team, both declaring
+// the same "com.apple.security.application-groups" entitlement) read and write one common blob of
+// data. Nothing here is @tastic/profile-specific — see src/sharedProfileStore.ts, the one caller,
+// for the profile-roster-shaped API built on top of this. Android/web never register this module
+// at all (see expo-module.config.json's "apple"-only platform list), so a consuming app has to
+// treat "module not present" as a normal, expected case rather than an error.
+public final class TasticProfileModule: Module {
+  public func definition() -> ModuleDefinition {
+    Name("TasticProfile")
+
+    AsyncFunction("getSharedJSON") { (groupId: String, key: String) -> String? in
+      UserDefaults(suiteName: groupId)?.string(forKey: key)
+    }
+
+    AsyncFunction("setSharedJSON") { (groupId: String, key: String, value: String) -> Void in
+      UserDefaults(suiteName: groupId)?.set(value, forKey: key)
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tastic/profile",
-  "version": "0.1.3",
+  "version": "0.3.1",
   "description": "Player profile identity for local-multiplayer React Native games — a saved name/color/tag a player selects per seat, with a picker, an inline-editable roster screen, and a reusable identity badge, deliberately blind to any app-specific fields (control scheme, stats) an app layers on top",
   "keywords": [
     "react-native",
@@ -39,13 +39,14 @@
   "files": [
     "dist",
     "src",
+    "ios",
+    "expo-module.config.json",
     "!src/__tests__",
     "!src/__mocks__"
   ],
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts --clean",
     "build:watch": "tsup src/index.ts --format cjs,esm --dts --watch",
-    "ci": "npm run lint && npm test && npm run typecheck && npm run build",
     "fix": "eslint --fix",
     "lint": "eslint",
     "prepublishOnly": "npm run build",
@@ -56,7 +57,8 @@
     "test": "jest",
     "test:watch": "jest --watchAll",
     "typecheck": "tsc --noEmit",
-    "preversion": "npm run ci"
+    "verify": "npm run lint && npm test && npm run typecheck && npm run build",
+    "preversion": "npm ci && npm run verify"
   },
   "prettier": "@infinitetoken/eslint-config/prettier",
   "devDependencies": {
@@ -75,6 +77,7 @@
     "eslint": "^9.39.4",
     "eslint-plugin-react-hooks": "^7.1.1",
     "eslint-plugin-react-native": "^5.0.0",
+    "expo-modules-core": "^57.0.14",
     "jest": "^30.4.2",
     "jest-environment-jsdom": "^30.4.1",
     "prettier": "^3.8.3",
@@ -94,11 +97,17 @@
     "@rific/toaster": ">=0.4.0",
     "@tastic/core": ">=0.1.0",
     "@tastic/hud": ">=0.1.3",
+    "expo-modules-core": ">=1.0.0",
     "react": ">=19.0.0",
     "react-native": ">=0.76.0",
     "react-native-paper": ">=5.0.0",
     "react-native-safe-area-context": ">=4.0.0"
   },
+  "peerDependenciesMeta": {
+    "expo-modules-core": {
+      "optional": true
+    }
+  },
   "publishConfig": {
     "access": "public"
   }

package/src/index.ts

@@ -2,4 +2,5 @@ export { ProfileChip } from './ProfileChip'
 export { ProfilePicker } from './ProfilePicker'
 export { ProfilesManager, type ProfilesManagerProps } from './ProfilesManager'
 export { isValidProfile, isValidTag, MAX_PROFILE_NAME_LENGTH, MAX_TAG_LENGTH } from './profilesValidation'
+export { isSharedProfileStoreAvailable, loadSharedProfiles, saveSharedProfiles } from './sharedProfileStore'
 export type { Profile } from './types'

package/src/sharedProfileStore.ts

@@ -0,0 +1,65 @@
+import { isValidProfile } from './profilesValidation'
+import { Profile } from './types'
+
+interface NativeTasticProfile {
+  getSharedJSON(groupId: string, key: string): Promise<string | null>
+  setSharedJSON(groupId: string, key: string, value: string): Promise<void>
+}
+
+// Lazily/optionally resolved — this package has no hard dependency on expo-modules-core (it's a
+// peer, provided by whatever Expo app consumes it), and the native module itself only registers on
+// iOS (see ios/TasticProfileModule.swift and expo-module.config.json's "apple"-only platform list).
+// Guarding both the require and the lookup means Android/web, and an iOS build that hasn't run
+// `expo prebuild` since adding this package yet, both degrade to "sharing unavailable" instead of a
+// hard crash.
+let native: NativeTasticProfile | null = null
+try {
+  const { requireOptionalNativeModule } = require('expo-modules-core')
+  native = (requireOptionalNativeModule('TasticProfile') ?? null) as NativeTasticProfile | null
+} catch {
+  native = null
+}
+
+const PROFILES_KEY = 'sharedProfiles'
+
+// True once at module load — a consuming app uses this to decide whether to fall back to its own
+// local-only storage for the base roster too (see this package's README's App Group section).
+export const isSharedProfileStoreAvailable = native !== null
+
+// Reads the shared base-identity roster out of a given App Group suite. Always resolves to an
+// array, never null/throws — an unavailable store, a missing/empty blob, and a corrupt blob all
+// read the same as "nothing shared yet." Entries that fail isValidProfile are dropped individually
+// rather than invalidating the whole roster, since the base fields validated here are the ONLY
+// thing this store is a source of truth for — a host app's own extension fields (a control scheme,
+// anything else) never travel through it at all; see the README for the base/extension split this
+// is meant to be used with.
+export async function loadSharedProfiles(groupId: string): Promise<Profile[]> {
+  if (!native) return []
+  let json: string | null = null
+  try {
+    json = await native.getSharedJSON(groupId, PROFILES_KEY)
+  } catch {
+    return []
+  }
+  if (!json) return []
+  try {
+    const parsed: unknown = JSON.parse(json)
+    return Array.isArray(parsed) ? parsed.filter(isValidProfile) : []
+  } catch {
+    return []
+  }
+}
+
+// Overwrites the entire shared roster — same whole-blob-write discipline a host app's own
+// AsyncStorage-backed profile store already uses, not an incremental per-profile update. A write
+// failure (store unavailable, or some other native error) is swallowed rather than thrown: the
+// caller's own local state is already the source of truth for what just changed, and this is a
+// best-effort mirror of it, not the other way around.
+export async function saveSharedProfiles(groupId: string, profiles: Profile[]): Promise<void> {
+  if (!native) return
+  try {
+    await native.setSharedJSON(groupId, PROFILES_KEY, JSON.stringify(profiles))
+  } catch {
+    // Best-effort — see doc comment above.
+  }
+}