api

Author: Krzysztof Borowy

.config/tsconfig.base.json

@@ -12,6 +12,7 @@
     "strict": true,
     "moduleResolution": "node",
     "resolveJsonModule": true,
+    "strictNullChecks": true,
     "allowJs": true,
     "checkJs": true,
     "allowSyntheticDefaultImports": true,

packages/core/.eslintrc renamed to packages/api/.eslintrc

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

packages/api/jest.config.js

@@ -1,5 +1,5 @@
 {
-  "name": "@react-native-async-storage/core",
+  "name": "@react-native-async-storage/api",
   "version": "0.0.0",
   "description": "Core API of Async Storage",
   "source": "src/index.ts",
@@ -17,7 +17,8 @@
     "prepack": "yarn build",
     "build": "bob build",
     "test:lint": "eslint src/**",
-    "test:ts": "tsc --noEmit"
+    "test:ts": "tsc --noEmit",
+    "test:jest": "jest"
   },
   "keywords": [
     "react-native",
@@ -30,8 +31,11 @@
   "author": "Krzysztof Borowy <[email protected]>",
   "license": "MIT",
   "devDependencies": {
+    "@types/jest": "29.5.4",
     "eslint": "8.26.0",
+    "jest": "29.5.0",
     "react-native-builder-bob": "0.20.0",
+    "ts-jest": "29.1.1",
     "typescript": "4.9.5"
   },
   "react-native-builder-bob": {

packages/core/package.json renamed to packages/api/package.json

@@ -0,0 +1,74 @@
+import { StorageKeys, StorageModel } from "./StorageModel";
+import { StorageExtension } from "./StorageExtension";
+
+/**
+ * AsyncStorage Interface
+ * Provides methods for managing asynchronous storage operations.
+ * @typeParam S - type of the storage model.
+ * @typeParam E - type of the storage extension, or unknown, if no extension is provided.
+ */
+export interface AsyncStorage<
+  S extends StorageModel,
+  E extends StorageExtension | unknown = unknown
+> {
+  /**
+   * Retrieves a single item from storage based on the provided key.
+   * @param key - The key to identify the item within the storage.
+   * @returns Promise resolving to the value associated with the key,
+   *          or null if the key does not exist.
+   */
+  getItem<K extends StorageKeys<S>>(key: K): Promise<S[K]>;
+
+  /**
+   * Sets the value of the specified item in the storage.
+   * @param key - The key under which the value should be stored.
+   * @param value - The value to be stored.
+   * @returns Promise that resolves when the operation is completed.
+   */
+  setItem<K extends StorageKeys<S>>(key: K, value: S[K]): Promise<void>;
+
+  /**
+   * Removes the item from storage identified by the provided key.
+   * @param key - The key of the item to be removed.
+   * @returns Promise that resolves when the operation is completed.
+   */
+  removeItem<K extends StorageKeys<S>>(key: K): Promise<void>;
+
+  /**
+   * Retrieves multiple items from storage based on the provided keys.
+   * @param keys - An array of keys to identify the items to be retrieved.
+   * @returns Promise resolving to an object with key-value pairs,
+   *          where the values are associated with the keys,
+   *          or null if a key does not exist.
+   */
+  getMany<K extends StorageKeys<S>>(keys: K[]): Promise<{ [k in K]: S[k] }>;
+
+  /**
+   * Sets multiple items in the storage.
+   * @param entries - An object containing key-value pairs to be stored.
+   * @returns Promise that resolves when the operation is completed.
+   */
+  setMany<K extends StorageKeys<S>>(entries: {
+    [k in K]: S[k];
+  }): Promise<void>;
+
+  /**
+   * Removes multiple items from storage based on the provided keys.
+   * @param keys - An array of keys identifying the items to be removed.
+   * @returns Promise that resolves when the operation is completed.
+   */
+  removeMany<K extends StorageKeys<S>>(keys: K[]): Promise<void>;
+
+  /**
+   * Clears all the data from the storage.
+   * @returns Promise that resolves when the operation is completed.
+   */
+  clear(): Promise<void>;
+
+  /**
+   * Represents the extension for providing additional functionality
+   * beyond the standard storage interface.
+   * See {@link StorageExtension} for more details.
+   */
+  ext: E;
+}

packages/api/src/AsyncStorage.ts

@@ -0,0 +1,6 @@
+/**
+ * The StorageExtension type serves as a means to extend the functionalities of the
+ * core interface beyond its operations. It acts as a placeholder for implementing
+ * additional methods.
+ */
+export type StorageExtension = {};

packages/api/src/StorageExtension.ts

@@ -0,0 +1,13 @@
+/**
+ * A type used to define the structure and shape of the data to be stored.
+ */
+export type StorageModel<
+  T extends Record<string, unknown> | unknown = unknown
+> = {
+  [K in keyof T]: NonNullable<T[K]> | null;
+};
+
+/**
+ * A utility type to extract key.
+ */
+export type StorageKeys<T> = keyof T;

packages/api/src/StorageModel.ts

@@ -0,0 +1,3 @@
+export { AsyncStorage } from "./AsyncStorage";
+export { StorageExtension } from "./StorageExtension";
+export * from "./StorageModel";

packages/api/src/index.ts

@@ -0,0 +1,7 @@
+{
+    "extends": "../../.config/tsconfig.base.json",
+    "include": ["./src/**/*", "./example/**/*"],
+    "compilerOptions": {
+        "types": ["jest"]
+    }
+}