@flare-engine/achievements 0.2.1 → 0.3.0

package/LICENSE

@@ -1,21 +1,201 @@
-MIT License
-
-Copyright (c) 2026 Grzegorz Otto
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Grzegorz Otto
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,2 @@
+Flare Engine
+Copyright 2026 Grzegorz Otto

package/README.md

@@ -1,6 +1,6 @@
 # @flare-engine/achievements
 
-Typed `AchievementsProvider` interface + `NoopAchievementsProvider` + React context. Stub-only at 0.1.0; concrete adapters (Game Center, Google Play Games, Steam) land at 0.2.0.
+Typed `AchievementsProvider` interface + `NoopAchievementsProvider` + React context, plus `createMemoryAchievements` / `createStorageAchievements` — local providers with a defined unlock/progress contract, for tests, dev, and single-player games. Concrete platform adapters (Game Center, Google Play Games, Steam) are post-launch; wire your own at the app boundary until then.
 
 ## Install
 
@@ -26,8 +26,33 @@ export function App() {
 }
 ```
 
-`useAchievements()` returns the provider; call `unlock(id)`, `setProgress(id, n)`, etc. against the interface — swapping `NoopAchievementsProvider` for a real adapter at 0.2.0 requires no consumer changes.
+`useAchievements()` returns the active provider. The `AchievementsProvider` surface is `unlock(id, progress?)`, `getState(id)`, and `getAll()` — all async. Progress is a partial `[0, 1]` value; omit it to fully unlock.
 
-## Recipe — env-var-gated lazy load
+## Local providers + the unlock contract
 
-When 0.2.0 adapters land (e.g. `@flare-engine/achievements-gamecenter`), wrap them behind an env-var gate so CI / unit tests / dev builds without API keys fall back to `NoopAchievementsProvider` and never touch the native SDK. See the [Lazy-SDK adapter recipe](https://github.com/grzott/flare-engine/blob/main/.claude/skills/flare-tier2-stubs/SKILL.md#lazy-sdk-adapter-recipe) for the full pattern; canonical implementation at [Pan Tvardowski's src/iap/provider.ts](https://github.com/grzott/Pan-Tvardowski/blob/main/src/iap/provider.ts) (RevenueCat / IAP — same shape).
+`createMemoryAchievements()` keeps state in memory; `createStorageAchievements(store, opts?)` persists it through an injected `{ get, set }` store. Both share the same contract — the semantics adapter authors should preserve:
+
+```ts
+import { createStorageAchievements } from '@flare-engine/achievements';
+import type { AchievementsStore } from '@flare-engine/achievements';
+
+declare const myStore: AchievementsStore;
+
+const achievements = createStorageAchievements(myStore); // { get, set }
+
+await achievements.unlock('first_blood', 0.5); // progress 0.5
+await achievements.unlock('first_blood', 0.2); // ignored — progress stays 0.5
+await achievements.unlock('first_blood');      // full unlock, latches
+await achievements.getState('first_blood');    // { unlocked: true, progress: 1, unlockedAt }
+```
+
+- **Clamped + monotonic:** progress is clamped to `[0, 1]` (non-finite → `0`) and never decreases — a lower requested value is ignored.
+- **`unlock(id)` fully unlocks** (target progress `1`).
+- **Latches:** reaching progress `1` sets `unlocked: true` and stamps `unlockedAt` once (via the injected `now`, default `Date.now`). Re-unlocking is a no-op — the original `unlockedAt` is kept.
+- **Untracked ids** report `{ unlocked: false, progress: 0 }`.
+
+`AchievementsStore` is a structural `{ get(key): Promise<string | null>; set(key, value): Promise<void> }` — the `get`/`set` subset of `@flare-engine/storage`'s `StorageAdapter`, so the storage provider adds no dependency and works with any async KV (AsyncStorage, an MMKV wrapper, a `localStorage` shim, …). It hydrates lazily from `store.get(key)` (default key `'flare.achievements'`), persists after every mutation, and serializes writes so concurrent unlocks can't lose an update.
+
+## Env-gated fallback
+
+In CI or dev builds without platform credentials, select `NoopAchievementsProvider` (or a local provider) behind your own env flag so nothing touches a native SDK until real credentials are present.

package/dist/index.d.mts

@@ -1,14 +1,13 @@
-import * as react from 'react';
-
+//#region src/provider.d.ts
 /** Opaque achievement identifier — adapter-defined. */
 type AchievementId = string;
 /** Current state of an achievement for the local player. */
 interface AchievementState {
-    id: AchievementId;
-    unlocked: boolean;
-    /** Partial progress in the range [0, 1]. `1` implies `unlocked: true`. */
-    progress: number;
-    unlockedAt?: number;
+  id: AchievementId;
+  unlocked: boolean;
+  /** Partial progress in the range [0, 1]. `1` implies `unlocked: true`. */
+  progress: number;
+  unlockedAt?: number;
 }
 /**
  * Achievement provider interface. Consumers supply a concrete adapter (Game
@@ -16,22 +15,65 @@ interface AchievementState {
  * `unlock()` is idempotent by contract — adapters must dedupe.
  */
 interface AchievementsProvider {
-    unlock(id: AchievementId, progress?: number): Promise<void>;
-    getState(id: AchievementId): Promise<AchievementState>;
-    getAll(): Promise<readonly AchievementState[]>;
+  unlock(id: AchievementId, progress?: number): Promise<void>;
+  getState(id: AchievementId): Promise<AchievementState>;
+  getAll(): Promise<readonly AchievementState[]>;
 }
 /**
  * Default no-op provider. All queries report `unlocked: false, progress: 0`;
  * unlocks resolve silently.
  */
 declare const NoopAchievementsProvider: AchievementsProvider;
-
+//#endregion
+//#region src/context.d.ts
 /**
  * React context carrying the active `AchievementsProvider`. Defaults to
  * `NoopAchievementsProvider`.
  */
-declare const AchievementsContext: react.Context<AchievementsProvider>;
+declare const AchievementsContext: import("react").Context<AchievementsProvider>;
 /** Hook returning the current `AchievementsProvider`. */
 declare function useAchievements(): AchievementsProvider;
-
-export { type AchievementId, type AchievementState, AchievementsContext, type AchievementsProvider, NoopAchievementsProvider, useAchievements };
+//#endregion
+//#region src/memory.d.ts
+/**
+ * Structural async key/value store the storage-backed provider persists into.
+ * Matches the `get`/`set` subset of `@flare-engine/storage`'s `StorageAdapter`
+ * so a real adapter can be injected without depending on the storage package.
+ */
+interface AchievementsStore {
+  /** Read a value. Resolves to `null` if the key is not present. */
+  get(key: string): Promise<string | null>;
+  /** Write a value. */
+  set(key: string, value: string): Promise<void>;
+}
+/** Options common to the in-memory and storage-backed providers. */
+interface MemoryAchievementsOptions {
+  /** Clock used to stamp `unlockedAt` on latch. Defaults to `() => Date.now()`. */
+  now?: () => number;
+}
+/** Options for the storage-backed provider. */
+interface StorageAchievementsOptions extends MemoryAchievementsOptions {
+  /** Persistence key passed to the injected store. Defaults to `'flare.achievements'`. */
+  key?: string;
+}
+/**
+ * In-memory `AchievementsProvider`. Progress is monotonic and unlocks latch with
+ * a single `unlockedAt` stamp; see {@link mergeAchievement} for exact semantics.
+ * State is not persisted — it lives for the lifetime of the returned provider.
+ */
+declare function createMemoryAchievements(opts?: MemoryAchievementsOptions): AchievementsProvider;
+/**
+ * Storage-backed `AchievementsProvider`. Shares the monotonic/latch semantics of
+ * {@link createMemoryAchievements} and persists into the injected
+ * {@link AchievementsStore}.
+ *
+ * State hydrates lazily from `store.get(key)` on the first call (a JSON array of
+ * `AchievementState`; a parse error hydrates empty) and is written back via
+ * `store.set` after every mutation. All mutations are serialized through a single
+ * chained tail promise so a read-modify-write can never interleave and lose an
+ * update under concurrent unlocks.
+ */
+declare function createStorageAchievements(store: AchievementsStore, opts?: StorageAchievementsOptions): AchievementsProvider;
+//#endregion
+export { type AchievementId, type AchievementState, AchievementsContext, type AchievementsProvider, type AchievementsStore, type MemoryAchievementsOptions, NoopAchievementsProvider, type StorageAchievementsOptions, createMemoryAchievements, createStorageAchievements, useAchievements };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/provider.ts","../src/context.ts","../src/memory.ts"],"mappings":";;KACY;;UAGK;EACf,IAAI;EACJ;;EAEA;EACA;;;;;;;UAQe;EACf,OAAO,IAAI,eAAe,oBAAoB;EAC9C,SAAS,IAAI,gBAAgB,QAAQ;EACrC,UAAU,iBAAiB;;;;;;cAOhB,0BAA0B;;;;;;;cCpB1B,qCAAmB,QAAA;;iBAGhB,mBAAmB;;;;;;;;UCHlB;;EAEf,IAAI,cAAc;;EAElB,IAAI,aAAa,gBAAgB;;;UAIlB;;EAEf;;;UAIe,mCAAmC;;EAElD;;;;;;;iBAiDc,yBAAyB,OAAO,4BAA4B;;;;;;;;;;;;iBA2B5D,0BACd,OAAO,mBACP,OAAO,6BACN"}

package/dist/index.d.ts

@@ -1,14 +1,13 @@
-import * as react from 'react';
-
+//#region src/provider.d.ts
 /** Opaque achievement identifier — adapter-defined. */
 type AchievementId = string;
 /** Current state of an achievement for the local player. */
 interface AchievementState {
-    id: AchievementId;
-    unlocked: boolean;
-    /** Partial progress in the range [0, 1]. `1` implies `unlocked: true`. */
-    progress: number;
-    unlockedAt?: number;
+  id: AchievementId;
+  unlocked: boolean;
+  /** Partial progress in the range [0, 1]. `1` implies `unlocked: true`. */
+  progress: number;
+  unlockedAt?: number;
 }
 /**
  * Achievement provider interface. Consumers supply a concrete adapter (Game
@@ -16,22 +15,65 @@ interface AchievementState {
  * `unlock()` is idempotent by contract — adapters must dedupe.
  */
 interface AchievementsProvider {
-    unlock(id: AchievementId, progress?: number): Promise<void>;
-    getState(id: AchievementId): Promise<AchievementState>;
-    getAll(): Promise<readonly AchievementState[]>;
+  unlock(id: AchievementId, progress?: number): Promise<void>;
+  getState(id: AchievementId): Promise<AchievementState>;
+  getAll(): Promise<readonly AchievementState[]>;
 }
 /**
  * Default no-op provider. All queries report `unlocked: false, progress: 0`;
  * unlocks resolve silently.
  */
 declare const NoopAchievementsProvider: AchievementsProvider;
-
+//#endregion
+//#region src/context.d.ts
 /**
  * React context carrying the active `AchievementsProvider`. Defaults to
  * `NoopAchievementsProvider`.
  */
-declare const AchievementsContext: react.Context<AchievementsProvider>;
+declare const AchievementsContext: import("react").Context<AchievementsProvider>;
 /** Hook returning the current `AchievementsProvider`. */
 declare function useAchievements(): AchievementsProvider;
-
-export { type AchievementId, type AchievementState, AchievementsContext, type AchievementsProvider, NoopAchievementsProvider, useAchievements };
+//#endregion
+//#region src/memory.d.ts
+/**
+ * Structural async key/value store the storage-backed provider persists into.
+ * Matches the `get`/`set` subset of `@flare-engine/storage`'s `StorageAdapter`
+ * so a real adapter can be injected without depending on the storage package.
+ */
+interface AchievementsStore {
+  /** Read a value. Resolves to `null` if the key is not present. */
+  get(key: string): Promise<string | null>;
+  /** Write a value. */
+  set(key: string, value: string): Promise<void>;
+}
+/** Options common to the in-memory and storage-backed providers. */
+interface MemoryAchievementsOptions {
+  /** Clock used to stamp `unlockedAt` on latch. Defaults to `() => Date.now()`. */
+  now?: () => number;
+}
+/** Options for the storage-backed provider. */
+interface StorageAchievementsOptions extends MemoryAchievementsOptions {
+  /** Persistence key passed to the injected store. Defaults to `'flare.achievements'`. */
+  key?: string;
+}
+/**
+ * In-memory `AchievementsProvider`. Progress is monotonic and unlocks latch with
+ * a single `unlockedAt` stamp; see {@link mergeAchievement} for exact semantics.
+ * State is not persisted — it lives for the lifetime of the returned provider.
+ */
+declare function createMemoryAchievements(opts?: MemoryAchievementsOptions): AchievementsProvider;
+/**
+ * Storage-backed `AchievementsProvider`. Shares the monotonic/latch semantics of
+ * {@link createMemoryAchievements} and persists into the injected
+ * {@link AchievementsStore}.
+ *
+ * State hydrates lazily from `store.get(key)` on the first call (a JSON array of
+ * `AchievementState`; a parse error hydrates empty) and is written back via
+ * `store.set` after every mutation. All mutations are serialized through a single
+ * chained tail promise so a read-modify-write can never interleave and lose an
+ * update under concurrent unlocks.
+ */
+declare function createStorageAchievements(store: AchievementsStore, opts?: StorageAchievementsOptions): AchievementsProvider;
+//#endregion
+export { type AchievementId, type AchievementState, AchievementsContext, type AchievementsProvider, type AchievementsStore, type MemoryAchievementsOptions, NoopAchievementsProvider, type StorageAchievementsOptions, createMemoryAchievements, createStorageAchievements, useAchievements };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/provider.ts","../src/context.ts","../src/memory.ts"],"mappings":";;KACY;;UAGK;EACf,IAAI;EACJ;;EAEA;EACA;;;;;;;UAQe;EACf,OAAO,IAAI,eAAe,oBAAoB;EAC9C,SAAS,IAAI,gBAAgB,QAAQ;EACrC,UAAU,iBAAiB;;;;;;cAOhB,0BAA0B;;;;;;;cCpB1B,qCAAmB,QAAA;;iBAGhB,mBAAmB;;;;;;;;UCHlB;;EAEf,IAAI,cAAc;;EAElB,IAAI,aAAa,gBAAgB;;;UAIlB;;EAEf;;;UAIe,mCAAmC;;EAElD;;;;;;;iBAiDc,yBAAyB,OAAO,4BAA4B;;;;;;;;;;;;iBA2B5D,0BACd,OAAO,mBACP,OAAO,6BACN"}

package/dist/index.js

@@ -1,53 +1,155 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let react = require("react");
+//#region src/provider.ts
+/**
+* Default no-op provider. All queries report `unlocked: false, progress: 0`;
+* unlocks resolve silently.
+*/
+const NoopAchievementsProvider = {
+	async unlock() {},
+	async getState(id) {
+		return {
+			id,
+			unlocked: false,
+			progress: 0
+		};
+	},
+	async getAll() {
+		return [];
+	}
 };
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  AchievementsContext: () => AchievementsContext,
-  NoopAchievementsProvider: () => NoopAchievementsProvider,
-  useAchievements: () => useAchievements
-});
-module.exports = __toCommonJS(index_exports);
-
-// src/provider.ts
-var NoopAchievementsProvider = {
-  async unlock() {
-  },
-  async getState(id) {
-    return { id, unlocked: false, progress: 0 };
-  },
-  async getAll() {
-    return [];
-  }
-};
-
-// src/context.ts
-var import_react = require("react");
-var AchievementsContext = (0, import_react.createContext)(NoopAchievementsProvider);
+//#endregion
+//#region src/context.ts
+/**
+* React context carrying the active `AchievementsProvider`. Defaults to
+* `NoopAchievementsProvider`.
+*/
+const AchievementsContext = (0, react.createContext)(NoopAchievementsProvider);
+/** Hook returning the current `AchievementsProvider`. */
 function useAchievements() {
-  return (0, import_react.useContext)(AchievementsContext);
+	return (0, react.useContext)(AchievementsContext);
+}
+//#endregion
+//#region src/memory.ts
+const DEFAULT_KEY = "flare.achievements";
+/** Coerce raw progress to `[0, 1]`; a non-finite value (NaN/Infinity) becomes `0`. */
+function normalizeProgress(value) {
+	if (!Number.isFinite(value)) return 0;
+	if (value < 0) return 0;
+	if (value > 1) return 1;
+	return value;
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  AchievementsContext,
-  NoopAchievementsProvider,
-  useAchievements
-});
+/** Default state for an untracked id — no `unlockedAt`. */
+function defaultState(id) {
+	return {
+		id,
+		unlocked: false,
+		progress: 0
+	};
+}
+/**
+* Pure state transition shared by both providers. Given the current state, an
+* optional progress arg and a clock, returns the next state:
+*
+* - `progress` omitted means a FULL unlock (target progress `1`).
+* - Progress is clamped to `[0, 1]`; non-finite input is treated as `0`.
+* - Progress is MONOTONIC — it never decreases below the stored value; a lower
+*   requested progress is ignored.
+* - Unlock LATCHES: reaching progress `1` sets `unlocked: true` and stamps
+*   `unlockedAt` once (via `now`). An already-unlocked state keeps its original
+*   `unlockedAt`, so re-unlocking is a no-op.
+*/
+function mergeAchievement(current, progress, now) {
+	const requested = progress === void 0 ? 1 : normalizeProgress(progress);
+	const nextProgress = requested > current.progress ? requested : current.progress;
+	if (!current.unlocked && nextProgress < 1) return {
+		id: current.id,
+		unlocked: false,
+		progress: nextProgress
+	};
+	const unlockedAt = current.unlockedAt ?? now();
+	return {
+		id: current.id,
+		unlocked: true,
+		progress: 1,
+		unlockedAt
+	};
+}
+/**
+* In-memory `AchievementsProvider`. Progress is monotonic and unlocks latch with
+* a single `unlockedAt` stamp; see {@link mergeAchievement} for exact semantics.
+* State is not persisted — it lives for the lifetime of the returned provider.
+*/
+function createMemoryAchievements(opts) {
+	const now = opts?.now ?? (() => Date.now());
+	const states = /* @__PURE__ */ new Map();
+	return {
+		async unlock(id, progress) {
+			states.set(id, mergeAchievement(states.get(id) ?? defaultState(id), progress, now));
+		},
+		async getState(id) {
+			return states.get(id) ?? defaultState(id);
+		},
+		async getAll() {
+			return [...states.values()];
+		}
+	};
+}
+/**
+* Storage-backed `AchievementsProvider`. Shares the monotonic/latch semantics of
+* {@link createMemoryAchievements} and persists into the injected
+* {@link AchievementsStore}.
+*
+* State hydrates lazily from `store.get(key)` on the first call (a JSON array of
+* `AchievementState`; a parse error hydrates empty) and is written back via
+* `store.set` after every mutation. All mutations are serialized through a single
+* chained tail promise so a read-modify-write can never interleave and lose an
+* update under concurrent unlocks.
+*/
+function createStorageAchievements(store, opts) {
+	const now = opts?.now ?? (() => Date.now());
+	const key = opts?.key ?? DEFAULT_KEY;
+	const states = /* @__PURE__ */ new Map();
+	let hydration;
+	let tail = Promise.resolve();
+	function hydrate() {
+		if (hydration === void 0) hydration = store.get(key).then((raw) => {
+			if (raw === null) return;
+			try {
+				const parsed = JSON.parse(raw);
+				for (const state of parsed) states.set(state.id, state);
+			} catch {}
+		});
+		return hydration;
+	}
+	function persist() {
+		return store.set(key, JSON.stringify([...states.values()]));
+	}
+	return {
+		unlock(id, progress) {
+			const run = tail.then(async () => {
+				await hydrate();
+				states.set(id, mergeAchievement(states.get(id) ?? defaultState(id), progress, now));
+				await persist();
+			});
+			tail = run.catch(() => {});
+			return run;
+		},
+		async getState(id) {
+			await hydrate();
+			return states.get(id) ?? defaultState(id);
+		},
+		async getAll() {
+			await hydrate();
+			return [...states.values()];
+		}
+	};
+}
+//#endregion
+exports.AchievementsContext = AchievementsContext;
+exports.NoopAchievementsProvider = NoopAchievementsProvider;
+exports.createMemoryAchievements = createMemoryAchievements;
+exports.createStorageAchievements = createStorageAchievements;
+exports.useAchievements = useAchievements;
+
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/provider.ts","../src/context.ts"],"sourcesContent":["export {\n  NoopAchievementsProvider,\n  type AchievementId,\n  type AchievementState,\n  type AchievementsProvider,\n} from './provider.js';\nexport { AchievementsContext, useAchievements } from './context.js';\n","/** Opaque achievement identifier — adapter-defined. */\nexport type AchievementId = string;\n\n/** Current state of an achievement for the local player. */\nexport interface AchievementState {\n  id: AchievementId;\n  unlocked: boolean;\n  /** Partial progress in the range [0, 1]. `1` implies `unlocked: true`. */\n  progress: number;\n  unlockedAt?: number;\n}\n\n/**\n * Achievement provider interface. Consumers supply a concrete adapter (Game\n * Center, Google Play Games, Steam, custom backend) at the app boundary.\n * `unlock()` is idempotent by contract — adapters must dedupe.\n */\nexport interface AchievementsProvider {\n  unlock(id: AchievementId, progress?: number): Promise<void>;\n  getState(id: AchievementId): Promise<AchievementState>;\n  getAll(): Promise<readonly AchievementState[]>;\n}\n\n/**\n * Default no-op provider. All queries report `unlocked: false, progress: 0`;\n * unlocks resolve silently.\n */\nexport const NoopAchievementsProvider: AchievementsProvider = {\n  async unlock(): Promise<void> {\n    // no-op\n  },\n  async getState(id: AchievementId): Promise<AchievementState> {\n    return { id, unlocked: false, progress: 0 };\n  },\n  async getAll(): Promise<readonly AchievementState[]> {\n    return [];\n  },\n};\n","import { createContext, useContext } from 'react';\nimport { type AchievementsProvider, NoopAchievementsProvider } from './provider.js';\n\n/**\n * React context carrying the active `AchievementsProvider`. Defaults to\n * `NoopAchievementsProvider`.\n */\nexport const AchievementsContext = createContext<AchievementsProvider>(NoopAchievementsProvider);\n\n/** Hook returning the current `AchievementsProvider`. */\nexport function useAchievements(): AchievementsProvider {\n  return useContext(AchievementsContext);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;AC2BO,IAAM,2BAAiD;AAAA,EAC5D,MAAM,SAAwB;AAAA,EAE9B;AAAA,EACA,MAAM,SAAS,IAA8C;AAC3D,WAAO,EAAE,IAAI,UAAU,OAAO,UAAU,EAAE;AAAA,EAC5C;AAAA,EACA,MAAM,SAA+C;AACnD,WAAO,CAAC;AAAA,EACV;AACF;;;ACrCA,mBAA0C;AAOnC,IAAM,0BAAsB,4BAAoC,wBAAwB;AAGxF,SAAS,kBAAwC;AACtD,aAAO,yBAAW,mBAAmB;AACvC;","names":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../src/provider.ts","../src/context.ts","../src/memory.ts"],"sourcesContent":["/** Opaque achievement identifier — adapter-defined. */\nexport type AchievementId = string;\n\n/** Current state of an achievement for the local player. */\nexport interface AchievementState {\n  id: AchievementId;\n  unlocked: boolean;\n  /** Partial progress in the range [0, 1]. `1` implies `unlocked: true`. */\n  progress: number;\n  unlockedAt?: number;\n}\n\n/**\n * Achievement provider interface. Consumers supply a concrete adapter (Game\n * Center, Google Play Games, Steam, custom backend) at the app boundary.\n * `unlock()` is idempotent by contract — adapters must dedupe.\n */\nexport interface AchievementsProvider {\n  unlock(id: AchievementId, progress?: number): Promise<void>;\n  getState(id: AchievementId): Promise<AchievementState>;\n  getAll(): Promise<readonly AchievementState[]>;\n}\n\n/**\n * Default no-op provider. All queries report `unlocked: false, progress: 0`;\n * unlocks resolve silently.\n */\nexport const NoopAchievementsProvider: AchievementsProvider = {\n  async unlock(): Promise<void> {\n    // no-op\n  },\n  async getState(id: AchievementId): Promise<AchievementState> {\n    return { id, unlocked: false, progress: 0 };\n  },\n  async getAll(): Promise<readonly AchievementState[]> {\n    return [];\n  },\n};\n","import { createContext, useContext } from 'react';\nimport { type AchievementsProvider, NoopAchievementsProvider } from './provider.js';\n\n/**\n * React context carrying the active `AchievementsProvider`. Defaults to\n * `NoopAchievementsProvider`.\n */\nexport const AchievementsContext = createContext<AchievementsProvider>(NoopAchievementsProvider);\n\n/** Hook returning the current `AchievementsProvider`. */\nexport function useAchievements(): AchievementsProvider {\n  return useContext(AchievementsContext);\n}\n","import type { AchievementId, AchievementState, AchievementsProvider } from './provider.js';\n\n/**\n * Structural async key/value store the storage-backed provider persists into.\n * Matches the `get`/`set` subset of `@flare-engine/storage`'s `StorageAdapter`\n * so a real adapter can be injected without depending on the storage package.\n */\nexport interface AchievementsStore {\n  /** Read a value. Resolves to `null` if the key is not present. */\n  get(key: string): Promise<string | null>;\n  /** Write a value. */\n  set(key: string, value: string): Promise<void>;\n}\n\n/** Options common to the in-memory and storage-backed providers. */\nexport interface MemoryAchievementsOptions {\n  /** Clock used to stamp `unlockedAt` on latch. Defaults to `() => Date.now()`. */\n  now?: () => number;\n}\n\n/** Options for the storage-backed provider. */\nexport interface StorageAchievementsOptions extends MemoryAchievementsOptions {\n  /** Persistence key passed to the injected store. Defaults to `'flare.achievements'`. */\n  key?: string;\n}\n\nconst DEFAULT_KEY = 'flare.achievements';\n\n/** Coerce raw progress to `[0, 1]`; a non-finite value (NaN/Infinity) becomes `0`. */\nfunction normalizeProgress(value: number): number {\n  if (!Number.isFinite(value)) return 0;\n  if (value < 0) return 0;\n  if (value > 1) return 1;\n  return value;\n}\n\n/** Default state for an untracked id — no `unlockedAt`. */\nfunction defaultState(id: AchievementId): AchievementState {\n  return { id, unlocked: false, progress: 0 };\n}\n\n/**\n * Pure state transition shared by both providers. Given the current state, an\n * optional progress arg and a clock, returns the next state:\n *\n * - `progress` omitted means a FULL unlock (target progress `1`).\n * - Progress is clamped to `[0, 1]`; non-finite input is treated as `0`.\n * - Progress is MONOTONIC — it never decreases below the stored value; a lower\n *   requested progress is ignored.\n * - Unlock LATCHES: reaching progress `1` sets `unlocked: true` and stamps\n *   `unlockedAt` once (via `now`). An already-unlocked state keeps its original\n *   `unlockedAt`, so re-unlocking is a no-op.\n */\nfunction mergeAchievement(\n  current: AchievementState,\n  progress: number | undefined,\n  now: () => number,\n): AchievementState {\n  const requested = progress === undefined ? 1 : normalizeProgress(progress);\n  const nextProgress = requested > current.progress ? requested : current.progress;\n  if (!current.unlocked && nextProgress < 1) {\n    return { id: current.id, unlocked: false, progress: nextProgress };\n  }\n  const unlockedAt = current.unlockedAt ?? now();\n  return { id: current.id, unlocked: true, progress: 1, unlockedAt };\n}\n\n/**\n * In-memory `AchievementsProvider`. Progress is monotonic and unlocks latch with\n * a single `unlockedAt` stamp; see {@link mergeAchievement} for exact semantics.\n * State is not persisted — it lives for the lifetime of the returned provider.\n */\nexport function createMemoryAchievements(opts?: MemoryAchievementsOptions): AchievementsProvider {\n  const now = opts?.now ?? (() => Date.now());\n  const states = new Map<AchievementId, AchievementState>();\n  return {\n    async unlock(id: AchievementId, progress?: number): Promise<void> {\n      states.set(id, mergeAchievement(states.get(id) ?? defaultState(id), progress, now));\n    },\n    async getState(id: AchievementId): Promise<AchievementState> {\n      return states.get(id) ?? defaultState(id);\n    },\n    async getAll(): Promise<readonly AchievementState[]> {\n      return [...states.values()];\n    },\n  };\n}\n\n/**\n * Storage-backed `AchievementsProvider`. Shares the monotonic/latch semantics of\n * {@link createMemoryAchievements} and persists into the injected\n * {@link AchievementsStore}.\n *\n * State hydrates lazily from `store.get(key)` on the first call (a JSON array of\n * `AchievementState`; a parse error hydrates empty) and is written back via\n * `store.set` after every mutation. All mutations are serialized through a single\n * chained tail promise so a read-modify-write can never interleave and lose an\n * update under concurrent unlocks.\n */\nexport function createStorageAchievements(\n  store: AchievementsStore,\n  opts?: StorageAchievementsOptions,\n): AchievementsProvider {\n  const now = opts?.now ?? (() => Date.now());\n  const key = opts?.key ?? DEFAULT_KEY;\n  const states = new Map<AchievementId, AchievementState>();\n  let hydration: Promise<void> | undefined;\n  let tail: Promise<void> = Promise.resolve();\n\n  function hydrate(): Promise<void> {\n    if (hydration === undefined) {\n      hydration = store.get(key).then((raw) => {\n        if (raw === null) return;\n        try {\n          const parsed = JSON.parse(raw) as AchievementState[];\n          for (const state of parsed) states.set(state.id, state);\n        } catch {\n          // Corrupt payload — hydrate empty.\n        }\n      });\n    }\n    return hydration;\n  }\n\n  function persist(): Promise<void> {\n    return store.set(key, JSON.stringify([...states.values()]));\n  }\n\n  return {\n    unlock(id: AchievementId, progress?: number): Promise<void> {\n      const run = tail.then(async () => {\n        await hydrate();\n        states.set(id, mergeAchievement(states.get(id) ?? defaultState(id), progress, now));\n        await persist();\n      });\n      // Swallow on the tail so one failed write cannot break serialization for\n      // later mutations; the caller still observes the error via `run`.\n      tail = run.catch(() => {});\n      return run;\n    },\n    async getState(id: AchievementId): Promise<AchievementState> {\n      await hydrate();\n      return states.get(id) ?? defaultState(id);\n    },\n    async getAll(): Promise<readonly AchievementState[]> {\n      await hydrate();\n      return [...states.values()];\n    },\n  };\n}\n"],"mappings":";;;;;;;AA2BA,MAAa,2BAAiD;CAC5D,MAAM,SAAwB,CAE9B;CACA,MAAM,SAAS,IAA8C;EAC3D,OAAO;GAAE;GAAI,UAAU;GAAO,UAAU;EAAE;CAC5C;CACA,MAAM,SAA+C;EACnD,OAAO,CAAC;CACV;AACF;;;;;;;AC9BA,MAAa,uBAAA,GAAA,MAAA,cAAA,CAA0D,wBAAwB;;AAG/F,SAAgB,kBAAwC;CACtD,QAAA,GAAA,MAAA,WAAA,CAAkB,mBAAmB;AACvC;;;ACcA,MAAM,cAAc;;AAGpB,SAAS,kBAAkB,OAAuB;CAChD,IAAI,CAAC,OAAO,SAAS,KAAK,GAAG,OAAO;CACpC,IAAI,QAAQ,GAAG,OAAO;CACtB,IAAI,QAAQ,GAAG,OAAO;CACtB,OAAO;AACT;;AAGA,SAAS,aAAa,IAAqC;CACzD,OAAO;EAAE;EAAI,UAAU;EAAO,UAAU;CAAE;AAC5C;;;;;;;;;;;;;AAcA,SAAS,iBACP,SACA,UACA,KACkB;CAClB,MAAM,YAAY,aAAa,KAAA,IAAY,IAAI,kBAAkB,QAAQ;CACzE,MAAM,eAAe,YAAY,QAAQ,WAAW,YAAY,QAAQ;CACxE,IAAI,CAAC,QAAQ,YAAY,eAAe,GACtC,OAAO;EAAE,IAAI,QAAQ;EAAI,UAAU;EAAO,UAAU;CAAa;CAEnE,MAAM,aAAa,QAAQ,cAAc,IAAI;CAC7C,OAAO;EAAE,IAAI,QAAQ;EAAI,UAAU;EAAM,UAAU;EAAG;CAAW;AACnE;;;;;;AAOA,SAAgB,yBAAyB,MAAwD;CAC/F,MAAM,MAAM,MAAM,cAAc,KAAK,IAAI;CACzC,MAAM,yBAAS,IAAI,IAAqC;CACxD,OAAO;EACL,MAAM,OAAO,IAAmB,UAAkC;GAChE,OAAO,IAAI,IAAI,iBAAiB,OAAO,IAAI,EAAE,KAAK,aAAa,EAAE,GAAG,UAAU,GAAG,CAAC;EACpF;EACA,MAAM,SAAS,IAA8C;GAC3D,OAAO,OAAO,IAAI,EAAE,KAAK,aAAa,EAAE;EAC1C;EACA,MAAM,SAA+C;GACnD,OAAO,CAAC,GAAG,OAAO,OAAO,CAAC;EAC5B;CACF;AACF;;;;;;;;;;;;AAaA,SAAgB,0BACd,OACA,MACsB;CACtB,MAAM,MAAM,MAAM,cAAc,KAAK,IAAI;CACzC,MAAM,MAAM,MAAM,OAAO;CACzB,MAAM,yBAAS,IAAI,IAAqC;CACxD,IAAI;CACJ,IAAI,OAAsB,QAAQ,QAAQ;CAE1C,SAAS,UAAyB;EAChC,IAAI,cAAc,KAAA,GAChB,YAAY,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,QAAQ;GACvC,IAAI,QAAQ,MAAM;GAClB,IAAI;IACF,MAAM,SAAS,KAAK,MAAM,GAAG;IAC7B,KAAK,MAAM,SAAS,QAAQ,OAAO,IAAI,MAAM,IAAI,KAAK;GACxD,QAAQ,CAER;EACF,CAAC;EAEH,OAAO;CACT;CAEA,SAAS,UAAyB;EAChC,OAAO,MAAM,IAAI,KAAK,KAAK,UAAU,CAAC,GAAG,OAAO,OAAO,CAAC,CAAC,CAAC;CAC5D;CAEA,OAAO;EACL,OAAO,IAAmB,UAAkC;GAC1D,MAAM,MAAM,KAAK,KAAK,YAAY;IAChC,MAAM,QAAQ;IACd,OAAO,IAAI,IAAI,iBAAiB,OAAO,IAAI,EAAE,KAAK,aAAa,EAAE,GAAG,UAAU,GAAG,CAAC;IAClF,MAAM,QAAQ;GAChB,CAAC;GAGD,OAAO,IAAI,YAAY,CAAC,CAAC;GACzB,OAAO;EACT;EACA,MAAM,SAAS,IAA8C;GAC3D,MAAM,QAAQ;GACd,OAAO,OAAO,IAAI,EAAE,KAAK,aAAa,EAAE;EAC1C;EACA,MAAM,SAA+C;GACnD,MAAM,QAAQ;GACd,OAAO,CAAC,GAAG,OAAO,OAAO,CAAC;EAC5B;CACF;AACF"}

package/dist/index.mjs

@@ -1,24 +1,150 @@
-// src/provider.ts
-var NoopAchievementsProvider = {
-  async unlock() {
-  },
-  async getState(id) {
-    return { id, unlocked: false, progress: 0 };
-  },
-  async getAll() {
-    return [];
-  }
-};
-
-// src/context.ts
 import { createContext, useContext } from "react";
-var AchievementsContext = createContext(NoopAchievementsProvider);
+//#region src/provider.ts
+/**
+* Default no-op provider. All queries report `unlocked: false, progress: 0`;
+* unlocks resolve silently.
+*/
+const NoopAchievementsProvider = {
+	async unlock() {},
+	async getState(id) {
+		return {
+			id,
+			unlocked: false,
+			progress: 0
+		};
+	},
+	async getAll() {
+		return [];
+	}
+};
+//#endregion
+//#region src/context.ts
+/**
+* React context carrying the active `AchievementsProvider`. Defaults to
+* `NoopAchievementsProvider`.
+*/
+const AchievementsContext = createContext(NoopAchievementsProvider);
+/** Hook returning the current `AchievementsProvider`. */
 function useAchievements() {
-  return useContext(AchievementsContext);
+	return useContext(AchievementsContext);
 }
-export {
-  AchievementsContext,
-  NoopAchievementsProvider,
-  useAchievements
-};
+//#endregion
+//#region src/memory.ts
+const DEFAULT_KEY = "flare.achievements";
+/** Coerce raw progress to `[0, 1]`; a non-finite value (NaN/Infinity) becomes `0`. */
+function normalizeProgress(value) {
+	if (!Number.isFinite(value)) return 0;
+	if (value < 0) return 0;
+	if (value > 1) return 1;
+	return value;
+}
+/** Default state for an untracked id — no `unlockedAt`. */
+function defaultState(id) {
+	return {
+		id,
+		unlocked: false,
+		progress: 0
+	};
+}
+/**
+* Pure state transition shared by both providers. Given the current state, an
+* optional progress arg and a clock, returns the next state:
+*
+* - `progress` omitted means a FULL unlock (target progress `1`).
+* - Progress is clamped to `[0, 1]`; non-finite input is treated as `0`.
+* - Progress is MONOTONIC — it never decreases below the stored value; a lower
+*   requested progress is ignored.
+* - Unlock LATCHES: reaching progress `1` sets `unlocked: true` and stamps
+*   `unlockedAt` once (via `now`). An already-unlocked state keeps its original
+*   `unlockedAt`, so re-unlocking is a no-op.
+*/
+function mergeAchievement(current, progress, now) {
+	const requested = progress === void 0 ? 1 : normalizeProgress(progress);
+	const nextProgress = requested > current.progress ? requested : current.progress;
+	if (!current.unlocked && nextProgress < 1) return {
+		id: current.id,
+		unlocked: false,
+		progress: nextProgress
+	};
+	const unlockedAt = current.unlockedAt ?? now();
+	return {
+		id: current.id,
+		unlocked: true,
+		progress: 1,
+		unlockedAt
+	};
+}
+/**
+* In-memory `AchievementsProvider`. Progress is monotonic and unlocks latch with
+* a single `unlockedAt` stamp; see {@link mergeAchievement} for exact semantics.
+* State is not persisted — it lives for the lifetime of the returned provider.
+*/
+function createMemoryAchievements(opts) {
+	const now = opts?.now ?? (() => Date.now());
+	const states = /* @__PURE__ */ new Map();
+	return {
+		async unlock(id, progress) {
+			states.set(id, mergeAchievement(states.get(id) ?? defaultState(id), progress, now));
+		},
+		async getState(id) {
+			return states.get(id) ?? defaultState(id);
+		},
+		async getAll() {
+			return [...states.values()];
+		}
+	};
+}
+/**
+* Storage-backed `AchievementsProvider`. Shares the monotonic/latch semantics of
+* {@link createMemoryAchievements} and persists into the injected
+* {@link AchievementsStore}.
+*
+* State hydrates lazily from `store.get(key)` on the first call (a JSON array of
+* `AchievementState`; a parse error hydrates empty) and is written back via
+* `store.set` after every mutation. All mutations are serialized through a single
+* chained tail promise so a read-modify-write can never interleave and lose an
+* update under concurrent unlocks.
+*/
+function createStorageAchievements(store, opts) {
+	const now = opts?.now ?? (() => Date.now());
+	const key = opts?.key ?? DEFAULT_KEY;
+	const states = /* @__PURE__ */ new Map();
+	let hydration;
+	let tail = Promise.resolve();
+	function hydrate() {
+		if (hydration === void 0) hydration = store.get(key).then((raw) => {
+			if (raw === null) return;
+			try {
+				const parsed = JSON.parse(raw);
+				for (const state of parsed) states.set(state.id, state);
+			} catch {}
+		});
+		return hydration;
+	}
+	function persist() {
+		return store.set(key, JSON.stringify([...states.values()]));
+	}
+	return {
+		unlock(id, progress) {
+			const run = tail.then(async () => {
+				await hydrate();
+				states.set(id, mergeAchievement(states.get(id) ?? defaultState(id), progress, now));
+				await persist();
+			});
+			tail = run.catch(() => {});
+			return run;
+		},
+		async getState(id) {
+			await hydrate();
+			return states.get(id) ?? defaultState(id);
+		},
+		async getAll() {
+			await hydrate();
+			return [...states.values()];
+		}
+	};
+}
+//#endregion
+export { AchievementsContext, NoopAchievementsProvider, createMemoryAchievements, createStorageAchievements, useAchievements };
+
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/provider.ts","../src/context.ts"],"sourcesContent":["/** Opaque achievement identifier — adapter-defined. */\nexport type AchievementId = string;\n\n/** Current state of an achievement for the local player. */\nexport interface AchievementState {\n  id: AchievementId;\n  unlocked: boolean;\n  /** Partial progress in the range [0, 1]. `1` implies `unlocked: true`. */\n  progress: number;\n  unlockedAt?: number;\n}\n\n/**\n * Achievement provider interface. Consumers supply a concrete adapter (Game\n * Center, Google Play Games, Steam, custom backend) at the app boundary.\n * `unlock()` is idempotent by contract — adapters must dedupe.\n */\nexport interface AchievementsProvider {\n  unlock(id: AchievementId, progress?: number): Promise<void>;\n  getState(id: AchievementId): Promise<AchievementState>;\n  getAll(): Promise<readonly AchievementState[]>;\n}\n\n/**\n * Default no-op provider. All queries report `unlocked: false, progress: 0`;\n * unlocks resolve silently.\n */\nexport const NoopAchievementsProvider: AchievementsProvider = {\n  async unlock(): Promise<void> {\n    // no-op\n  },\n  async getState(id: AchievementId): Promise<AchievementState> {\n    return { id, unlocked: false, progress: 0 };\n  },\n  async getAll(): Promise<readonly AchievementState[]> {\n    return [];\n  },\n};\n","import { createContext, useContext } from 'react';\nimport { type AchievementsProvider, NoopAchievementsProvider } from './provider.js';\n\n/**\n * React context carrying the active `AchievementsProvider`. Defaults to\n * `NoopAchievementsProvider`.\n */\nexport const AchievementsContext = createContext<AchievementsProvider>(NoopAchievementsProvider);\n\n/** Hook returning the current `AchievementsProvider`. */\nexport function useAchievements(): AchievementsProvider {\n  return useContext(AchievementsContext);\n}\n"],"mappings":";AA2BO,IAAM,2BAAiD;AAAA,EAC5D,MAAM,SAAwB;AAAA,EAE9B;AAAA,EACA,MAAM,SAAS,IAA8C;AAC3D,WAAO,EAAE,IAAI,UAAU,OAAO,UAAU,EAAE;AAAA,EAC5C;AAAA,EACA,MAAM,SAA+C;AACnD,WAAO,CAAC;AAAA,EACV;AACF;;;ACrCA,SAAS,eAAe,kBAAkB;AAOnC,IAAM,sBAAsB,cAAoC,wBAAwB;AAGxF,SAAS,kBAAwC;AACtD,SAAO,WAAW,mBAAmB;AACvC;","names":[]}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/provider.ts","../src/context.ts","../src/memory.ts"],"sourcesContent":["/** Opaque achievement identifier — adapter-defined. */\nexport type AchievementId = string;\n\n/** Current state of an achievement for the local player. */\nexport interface AchievementState {\n  id: AchievementId;\n  unlocked: boolean;\n  /** Partial progress in the range [0, 1]. `1` implies `unlocked: true`. */\n  progress: number;\n  unlockedAt?: number;\n}\n\n/**\n * Achievement provider interface. Consumers supply a concrete adapter (Game\n * Center, Google Play Games, Steam, custom backend) at the app boundary.\n * `unlock()` is idempotent by contract — adapters must dedupe.\n */\nexport interface AchievementsProvider {\n  unlock(id: AchievementId, progress?: number): Promise<void>;\n  getState(id: AchievementId): Promise<AchievementState>;\n  getAll(): Promise<readonly AchievementState[]>;\n}\n\n/**\n * Default no-op provider. All queries report `unlocked: false, progress: 0`;\n * unlocks resolve silently.\n */\nexport const NoopAchievementsProvider: AchievementsProvider = {\n  async unlock(): Promise<void> {\n    // no-op\n  },\n  async getState(id: AchievementId): Promise<AchievementState> {\n    return { id, unlocked: false, progress: 0 };\n  },\n  async getAll(): Promise<readonly AchievementState[]> {\n    return [];\n  },\n};\n","import { createContext, useContext } from 'react';\nimport { type AchievementsProvider, NoopAchievementsProvider } from './provider.js';\n\n/**\n * React context carrying the active `AchievementsProvider`. Defaults to\n * `NoopAchievementsProvider`.\n */\nexport const AchievementsContext = createContext<AchievementsProvider>(NoopAchievementsProvider);\n\n/** Hook returning the current `AchievementsProvider`. */\nexport function useAchievements(): AchievementsProvider {\n  return useContext(AchievementsContext);\n}\n","import type { AchievementId, AchievementState, AchievementsProvider } from './provider.js';\n\n/**\n * Structural async key/value store the storage-backed provider persists into.\n * Matches the `get`/`set` subset of `@flare-engine/storage`'s `StorageAdapter`\n * so a real adapter can be injected without depending on the storage package.\n */\nexport interface AchievementsStore {\n  /** Read a value. Resolves to `null` if the key is not present. */\n  get(key: string): Promise<string | null>;\n  /** Write a value. */\n  set(key: string, value: string): Promise<void>;\n}\n\n/** Options common to the in-memory and storage-backed providers. */\nexport interface MemoryAchievementsOptions {\n  /** Clock used to stamp `unlockedAt` on latch. Defaults to `() => Date.now()`. */\n  now?: () => number;\n}\n\n/** Options for the storage-backed provider. */\nexport interface StorageAchievementsOptions extends MemoryAchievementsOptions {\n  /** Persistence key passed to the injected store. Defaults to `'flare.achievements'`. */\n  key?: string;\n}\n\nconst DEFAULT_KEY = 'flare.achievements';\n\n/** Coerce raw progress to `[0, 1]`; a non-finite value (NaN/Infinity) becomes `0`. */\nfunction normalizeProgress(value: number): number {\n  if (!Number.isFinite(value)) return 0;\n  if (value < 0) return 0;\n  if (value > 1) return 1;\n  return value;\n}\n\n/** Default state for an untracked id — no `unlockedAt`. */\nfunction defaultState(id: AchievementId): AchievementState {\n  return { id, unlocked: false, progress: 0 };\n}\n\n/**\n * Pure state transition shared by both providers. Given the current state, an\n * optional progress arg and a clock, returns the next state:\n *\n * - `progress` omitted means a FULL unlock (target progress `1`).\n * - Progress is clamped to `[0, 1]`; non-finite input is treated as `0`.\n * - Progress is MONOTONIC — it never decreases below the stored value; a lower\n *   requested progress is ignored.\n * - Unlock LATCHES: reaching progress `1` sets `unlocked: true` and stamps\n *   `unlockedAt` once (via `now`). An already-unlocked state keeps its original\n *   `unlockedAt`, so re-unlocking is a no-op.\n */\nfunction mergeAchievement(\n  current: AchievementState,\n  progress: number | undefined,\n  now: () => number,\n): AchievementState {\n  const requested = progress === undefined ? 1 : normalizeProgress(progress);\n  const nextProgress = requested > current.progress ? requested : current.progress;\n  if (!current.unlocked && nextProgress < 1) {\n    return { id: current.id, unlocked: false, progress: nextProgress };\n  }\n  const unlockedAt = current.unlockedAt ?? now();\n  return { id: current.id, unlocked: true, progress: 1, unlockedAt };\n}\n\n/**\n * In-memory `AchievementsProvider`. Progress is monotonic and unlocks latch with\n * a single `unlockedAt` stamp; see {@link mergeAchievement} for exact semantics.\n * State is not persisted — it lives for the lifetime of the returned provider.\n */\nexport function createMemoryAchievements(opts?: MemoryAchievementsOptions): AchievementsProvider {\n  const now = opts?.now ?? (() => Date.now());\n  const states = new Map<AchievementId, AchievementState>();\n  return {\n    async unlock(id: AchievementId, progress?: number): Promise<void> {\n      states.set(id, mergeAchievement(states.get(id) ?? defaultState(id), progress, now));\n    },\n    async getState(id: AchievementId): Promise<AchievementState> {\n      return states.get(id) ?? defaultState(id);\n    },\n    async getAll(): Promise<readonly AchievementState[]> {\n      return [...states.values()];\n    },\n  };\n}\n\n/**\n * Storage-backed `AchievementsProvider`. Shares the monotonic/latch semantics of\n * {@link createMemoryAchievements} and persists into the injected\n * {@link AchievementsStore}.\n *\n * State hydrates lazily from `store.get(key)` on the first call (a JSON array of\n * `AchievementState`; a parse error hydrates empty) and is written back via\n * `store.set` after every mutation. All mutations are serialized through a single\n * chained tail promise so a read-modify-write can never interleave and lose an\n * update under concurrent unlocks.\n */\nexport function createStorageAchievements(\n  store: AchievementsStore,\n  opts?: StorageAchievementsOptions,\n): AchievementsProvider {\n  const now = opts?.now ?? (() => Date.now());\n  const key = opts?.key ?? DEFAULT_KEY;\n  const states = new Map<AchievementId, AchievementState>();\n  let hydration: Promise<void> | undefined;\n  let tail: Promise<void> = Promise.resolve();\n\n  function hydrate(): Promise<void> {\n    if (hydration === undefined) {\n      hydration = store.get(key).then((raw) => {\n        if (raw === null) return;\n        try {\n          const parsed = JSON.parse(raw) as AchievementState[];\n          for (const state of parsed) states.set(state.id, state);\n        } catch {\n          // Corrupt payload — hydrate empty.\n        }\n      });\n    }\n    return hydration;\n  }\n\n  function persist(): Promise<void> {\n    return store.set(key, JSON.stringify([...states.values()]));\n  }\n\n  return {\n    unlock(id: AchievementId, progress?: number): Promise<void> {\n      const run = tail.then(async () => {\n        await hydrate();\n        states.set(id, mergeAchievement(states.get(id) ?? defaultState(id), progress, now));\n        await persist();\n      });\n      // Swallow on the tail so one failed write cannot break serialization for\n      // later mutations; the caller still observes the error via `run`.\n      tail = run.catch(() => {});\n      return run;\n    },\n    async getState(id: AchievementId): Promise<AchievementState> {\n      await hydrate();\n      return states.get(id) ?? defaultState(id);\n    },\n    async getAll(): Promise<readonly AchievementState[]> {\n      await hydrate();\n      return [...states.values()];\n    },\n  };\n}\n"],"mappings":";;;;;;AA2BA,MAAa,2BAAiD;CAC5D,MAAM,SAAwB,CAE9B;CACA,MAAM,SAAS,IAA8C;EAC3D,OAAO;GAAE;GAAI,UAAU;GAAO,UAAU;EAAE;CAC5C;CACA,MAAM,SAA+C;EACnD,OAAO,CAAC;CACV;AACF;;;;;;;AC9BA,MAAa,sBAAsB,cAAoC,wBAAwB;;AAG/F,SAAgB,kBAAwC;CACtD,OAAO,WAAW,mBAAmB;AACvC;;;ACcA,MAAM,cAAc;;AAGpB,SAAS,kBAAkB,OAAuB;CAChD,IAAI,CAAC,OAAO,SAAS,KAAK,GAAG,OAAO;CACpC,IAAI,QAAQ,GAAG,OAAO;CACtB,IAAI,QAAQ,GAAG,OAAO;CACtB,OAAO;AACT;;AAGA,SAAS,aAAa,IAAqC;CACzD,OAAO;EAAE;EAAI,UAAU;EAAO,UAAU;CAAE;AAC5C;;;;;;;;;;;;;AAcA,SAAS,iBACP,SACA,UACA,KACkB;CAClB,MAAM,YAAY,aAAa,KAAA,IAAY,IAAI,kBAAkB,QAAQ;CACzE,MAAM,eAAe,YAAY,QAAQ,WAAW,YAAY,QAAQ;CACxE,IAAI,CAAC,QAAQ,YAAY,eAAe,GACtC,OAAO;EAAE,IAAI,QAAQ;EAAI,UAAU;EAAO,UAAU;CAAa;CAEnE,MAAM,aAAa,QAAQ,cAAc,IAAI;CAC7C,OAAO;EAAE,IAAI,QAAQ;EAAI,UAAU;EAAM,UAAU;EAAG;CAAW;AACnE;;;;;;AAOA,SAAgB,yBAAyB,MAAwD;CAC/F,MAAM,MAAM,MAAM,cAAc,KAAK,IAAI;CACzC,MAAM,yBAAS,IAAI,IAAqC;CACxD,OAAO;EACL,MAAM,OAAO,IAAmB,UAAkC;GAChE,OAAO,IAAI,IAAI,iBAAiB,OAAO,IAAI,EAAE,KAAK,aAAa,EAAE,GAAG,UAAU,GAAG,CAAC;EACpF;EACA,MAAM,SAAS,IAA8C;GAC3D,OAAO,OAAO,IAAI,EAAE,KAAK,aAAa,EAAE;EAC1C;EACA,MAAM,SAA+C;GACnD,OAAO,CAAC,GAAG,OAAO,OAAO,CAAC;EAC5B;CACF;AACF;;;;;;;;;;;;AAaA,SAAgB,0BACd,OACA,MACsB;CACtB,MAAM,MAAM,MAAM,cAAc,KAAK,IAAI;CACzC,MAAM,MAAM,MAAM,OAAO;CACzB,MAAM,yBAAS,IAAI,IAAqC;CACxD,IAAI;CACJ,IAAI,OAAsB,QAAQ,QAAQ;CAE1C,SAAS,UAAyB;EAChC,IAAI,cAAc,KAAA,GAChB,YAAY,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,QAAQ;GACvC,IAAI,QAAQ,MAAM;GAClB,IAAI;IACF,MAAM,SAAS,KAAK,MAAM,GAAG;IAC7B,KAAK,MAAM,SAAS,QAAQ,OAAO,IAAI,MAAM,IAAI,KAAK;GACxD,QAAQ,CAER;EACF,CAAC;EAEH,OAAO;CACT;CAEA,SAAS,UAAyB;EAChC,OAAO,MAAM,IAAI,KAAK,KAAK,UAAU,CAAC,GAAG,OAAO,OAAO,CAAC,CAAC,CAAC;CAC5D;CAEA,OAAO;EACL,OAAO,IAAmB,UAAkC;GAC1D,MAAM,MAAM,KAAK,KAAK,YAAY;IAChC,MAAM,QAAQ;IACd,OAAO,IAAI,IAAI,iBAAiB,OAAO,IAAI,EAAE,KAAK,aAAa,EAAE,GAAG,UAAU,GAAG,CAAC;IAClF,MAAM,QAAQ;GAChB,CAAC;GAGD,OAAO,IAAI,YAAY,CAAC,CAAC;GACzB,OAAO;EACT;EACA,MAAM,SAAS,IAA8C;GAC3D,MAAM,QAAQ;GACd,OAAO,OAAO,IAAI,EAAE,KAAK,aAAa,EAAE;EAC1C;EACA,MAAM,SAA+C;GACnD,MAAM,QAAQ;GACd,OAAO,CAAC,GAAG,OAAO,OAAO,CAAC;EAC5B;CACF;AACF"}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@flare-engine/achievements",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Achievements provider interface (consumer-supplied adapter)",
   "keywords": ["flare-engine", "achievements", "provider", "interface"],
-  "license": "MIT",
+  "license": "Apache-2.0",
   "author": "Grzegorz Otto",
   "homepage": "https://github.com/grzott/flare-engine#readme",
   "bugs": {
@@ -19,23 +19,31 @@
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js"
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
     }
   },
-  "files": ["dist", "README.md", "LICENSE"],
+  "files": ["dist", "README.md", "LICENSE", "NOTICE"],
   "scripts": {
-    "build": "tsup",
+    "build": "tsdown",
     "test": "bun test",
     "lint": "biome check src/",
     "typecheck": "tsc --noEmit"
   },
   "devDependencies": {
-    "@types/react": "^18.0.0"
+    "@types/react": "^19.0.0"
   },
   "peerDependencies": {
-    "react": ">=18.0.0"
+    "react": ">=19.0.0"
+  },
+  "engines": {
+    "node": ">=20"
   },
   "publishConfig": {
     "access": "restricted",