@forthtilliath/react-native-kit 0.15.1 → 0.17.0

package/dist/utils/helpers/isNativeModuleAvailable.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Whether the native module `name` is compiled into this binary (new or old
+ * architecture). Check it before loading a library that requires its native
+ * module on import: on a binary built without it (an older dev build),
+ * importing it anyway crashes the whole screen instead of disabling the one
+ * feature that needs it.
+ *
+ * @example
+ * if (isNativeModuleAvailable("RNViewShot")) showShareAsImageButton();
+ */
+export declare function isNativeModuleAvailable(name: string): boolean;
+//# sourceMappingURL=isNativeModuleAvailable.d.ts.map

package/dist/utils/helpers/isNativeModuleAvailable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isNativeModuleAvailable.d.ts","sourceRoot":"","sources":["../../../src/utils/helpers/isNativeModuleAvailable.ts"],"names":[],"mappings":"AAMA;;;;;;;;;GASG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAK7D"}

package/dist/utils/helpers/isNativeModuleAvailable.js

@@ -0,0 +1,15 @@
+import { NativeModules, TurboModuleRegistry, } from "react-native";
+/**
+ * Whether the native module `name` is compiled into this binary (new or old
+ * architecture). Check it before loading a library that requires its native
+ * module on import: on a binary built without it (an older dev build),
+ * importing it anyway crashes the whole screen instead of disabling the one
+ * feature that needs it.
+ *
+ * @example
+ * if (isNativeModuleAvailable("RNViewShot")) showShareAsImageButton();
+ */
+export function isNativeModuleAvailable(name) {
+    return (TurboModuleRegistry.get(name) != null ||
+        NativeModules[name] != null);
+}

package/dist/utils/helpers/shareFile.d.ts

@@ -0,0 +1,23 @@
+import { type KitLocale } from "../../i18n/locale.js";
+export interface ShareFileOptions {
+    /** E.g. `"text/calendar"`, `"image/png"`. */
+    mimeType: string;
+    /** Title of Android's share sheet. */
+    dialogTitle?: string;
+    /** Language of the default error message. @defaultValue "fr" */
+    locale?: KitLocale;
+    /** Message of the error thrown when the device can't share. */
+    unavailableMessage?: string;
+}
+/**
+ * Opens the native share sheet for a local file (a capture, an export…).
+ * Needs `expo-sharing` (an optional peer dependency).
+ *
+ * @param uri - A `file://` URI.
+ * @param options - See {@link ShareFileOptions}.
+ * @throws An `Error` with a user-facing message when sharing isn't available.
+ * @example
+ * await shareFile(captureUri, { mimeType: "image/png", dialogTitle: "Partager le planning" });
+ */
+export declare function shareFile(uri: string, options: ShareFileOptions): Promise<void>;
+//# sourceMappingURL=shareFile.d.ts.map

package/dist/utils/helpers/shareFile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shareFile.d.ts","sourceRoot":"","sources":["../../../src/utils/helpers/shareFile.ts"],"names":[],"mappings":"AAEA,OAAO,EAAsB,KAAK,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAE1E,MAAM,WAAW,gBAAgB;IAC/B,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,sCAAsC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,+DAA+D;IAC/D,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAOD;;;;;;;;;GASG;AACH,wBAAsB,SAAS,CAC7B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,CAWf"}

package/dist/utils/helpers/shareFile.js

@@ -0,0 +1,26 @@
+import * as Sharing from "expo-sharing";
+import { DEFAULT_KIT_LOCALE } from "../../i18n/locale.js";
+const defaultUnavailableMessages = {
+    fr: "Le partage n'est pas disponible sur cet appareil.",
+    en: "Sharing isn't available on this device.",
+};
+/**
+ * Opens the native share sheet for a local file (a capture, an export…).
+ * Needs `expo-sharing` (an optional peer dependency).
+ *
+ * @param uri - A `file://` URI.
+ * @param options - See {@link ShareFileOptions}.
+ * @throws An `Error` with a user-facing message when sharing isn't available.
+ * @example
+ * await shareFile(captureUri, { mimeType: "image/png", dialogTitle: "Partager le planning" });
+ */
+export async function shareFile(uri, options) {
+    if (!(await Sharing.isAvailableAsync())) {
+        throw new Error(options.unavailableMessage ??
+            defaultUnavailableMessages[options.locale ?? DEFAULT_KIT_LOCALE]);
+    }
+    await Sharing.shareAsync(uri, {
+        mimeType: options.mimeType,
+        dialogTitle: options.dialogTitle,
+    });
+}

package/dist/utils/helpers/shareTextFile.d.ts

@@ -0,0 +1,16 @@
+import { type ShareFileOptions } from "./shareFile.js";
+/**
+ * Writes text to a file in the app's cache (replacing any previous one of
+ * that name), then opens the native share sheet for it — to export an
+ * `.ics`, a `.csv`, a JSON backup… Needs `expo-file-system` and
+ * `expo-sharing` (optional peer dependencies).
+ *
+ * @param filename - The shared file's name, extension included.
+ * @param content - Its text content.
+ * @param options - See `ShareFileOptions`.
+ * @throws An `Error` with a user-facing message when sharing isn't available.
+ * @example
+ * await shareTextFile("planning-2026-07.ics", ics, { mimeType: "text/calendar" });
+ */
+export declare function shareTextFile(filename: string, content: string, options: ShareFileOptions): Promise<void>;
+//# sourceMappingURL=shareTextFile.d.ts.map

package/dist/utils/helpers/shareTextFile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shareTextFile.d.ts","sourceRoot":"","sources":["../../../src/utils/helpers/shareTextFile.ts"],"names":[],"mappings":"AAEA,OAAO,EAAa,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElE;;;;;;;;;;;;GAYG;AACH,wBAAsB,aAAa,CACjC,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,CAMf"}

package/dist/utils/helpers/shareTextFile.js

@@ -0,0 +1,23 @@
+import { File, Paths } from "expo-file-system";
+import { shareFile } from "./shareFile.js";
+/**
+ * Writes text to a file in the app's cache (replacing any previous one of
+ * that name), then opens the native share sheet for it — to export an
+ * `.ics`, a `.csv`, a JSON backup… Needs `expo-file-system` and
+ * `expo-sharing` (optional peer dependencies).
+ *
+ * @param filename - The shared file's name, extension included.
+ * @param content - Its text content.
+ * @param options - See `ShareFileOptions`.
+ * @throws An `Error` with a user-facing message when sharing isn't available.
+ * @example
+ * await shareTextFile("planning-2026-07.ics", ics, { mimeType: "text/calendar" });
+ */
+export async function shareTextFile(filename, content, options) {
+    const file = new File(Paths.cache, filename);
+    if (file.exists)
+        file.delete();
+    file.create({ overwrite: true });
+    file.write(content);
+    await shareFile(file.uri, options);
+}

package/dist/utils/helpers/shareViewAsImage.d.ts

@@ -0,0 +1,21 @@
+import type { RefObject } from "react";
+import type { View } from "react-native";
+import { type ShareFileOptions } from "./shareFile.js";
+export type ShareViewAsImageOptions = Omit<ShareFileOptions, "mimeType"> & {
+    /** Message of the error thrown when this binary can't capture views. */
+    captureUnavailableMessage?: string;
+};
+/**
+ * Captures a view as a PNG and opens the native share sheet with it (a
+ * scoreboard, a schedule…). Needs `react-native-view-shot` and
+ * `expo-sharing`. The capture library is loaded on demand, once its native
+ * module is known to be there: on a binary built without it, only this
+ * feature fails — with a user-facing `Error` — instead of the whole screen.
+ *
+ * @param view - Ref of the view to capture (`collapsable={false}` on Android).
+ * @param options - See {@link ShareViewAsImageOptions} and `shareFile`.
+ * @example
+ * await shareViewAsImage(rankingRef, { dialogTitle: "Partager le classement" });
+ */
+export declare function shareViewAsImage(view: RefObject<View | null>, { captureUnavailableMessage, ...options }?: ShareViewAsImageOptions): Promise<void>;
+//# sourceMappingURL=shareViewAsImage.d.ts.map

package/dist/utils/helpers/shareViewAsImage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shareViewAsImage.d.ts","sourceRoot":"","sources":["../../../src/utils/helpers/shareViewAsImage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAKzC,OAAO,EAAa,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElE,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,GAAG;IACzE,wEAAwE;IACxE,yBAAyB,CAAC,EAAE,MAAM,CAAC;CACpC,CAAC;AAOF;;;;;;;;;;;GAWG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,EAC5B,EAAE,yBAAyB,EAAE,GAAG,OAAO,EAAE,GAAE,uBAA4B,GACtE,OAAO,CAAC,IAAI,CAAC,CAcf"}

package/dist/utils/helpers/shareViewAsImage.js

@@ -0,0 +1,32 @@
+import { DEFAULT_KIT_LOCALE } from "../../i18n/locale.js";
+import { isNativeModuleAvailable } from "./isNativeModuleAvailable.js";
+import { shareFile } from "./shareFile.js";
+const defaultCaptureUnavailableMessages = {
+    fr: "Le partage en image n'est pas disponible dans cette version de l'app.",
+    en: "Sharing as an image isn't available in this version of the app.",
+};
+/**
+ * Captures a view as a PNG and opens the native share sheet with it (a
+ * scoreboard, a schedule…). Needs `react-native-view-shot` and
+ * `expo-sharing`. The capture library is loaded on demand, once its native
+ * module is known to be there: on a binary built without it, only this
+ * feature fails — with a user-facing `Error` — instead of the whole screen.
+ *
+ * @param view - Ref of the view to capture (`collapsable={false}` on Android).
+ * @param options - See {@link ShareViewAsImageOptions} and `shareFile`.
+ * @example
+ * await shareViewAsImage(rankingRef, { dialogTitle: "Partager le classement" });
+ */
+export async function shareViewAsImage(view, { captureUnavailableMessage, ...options } = {}) {
+    if (!isNativeModuleAvailable("RNViewShot")) {
+        throw new Error(captureUnavailableMessage ??
+            defaultCaptureUnavailableMessages[options.locale ?? DEFAULT_KIT_LOCALE]);
+    }
+    const { captureRef } = await import("react-native-view-shot");
+    const uri = await captureRef(view, {
+        format: "png",
+        quality: 1,
+        result: "tmpfile",
+    });
+    await shareFile(uri, { ...options, mimeType: "image/png" });
+}

package/dist/utils/index.d.ts

@@ -1,2 +1,4 @@
+export * from "./calendar/index.js";
+export * from "./files/index.js";
 export * from "./helpers/index.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC"}

package/dist/utils/index.js

@@ -1 +1,3 @@
+export * from "./calendar/index.js";
+export * from "./files/index.js";
 export * from "./helpers/index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forthtilliath/react-native-kit",
-  "version": "0.15.1",
+  "version": "0.17.0",
   "type": "module",
   "sideEffects": false,
   "license": "MIT",
@@ -22,17 +22,61 @@
     "./*": "./dist/*.js"
   },
   "dependencies": {
-    "@forthtilliath/expo-release-updates-ui": "^0.3.1",
-    "@forthtilliath/ts-kit": "^0.11.0"
+    "@forthtilliath/ts-kit": "^0.12.0"
   },
   "peerDependencies": {
     "@expo/vector-icons": ">=15.0.0",
+    "@forthtilliath/expo-release-updates-ui": ">=0.4.1",
+    "expo-calendar": ">=54.0.0",
+    "expo-file-system": ">=54.0.0",
+    "expo-haptics": ">=54.0.0",
+    "expo-image-manipulator": ">=54.0.0",
     "expo-image-picker": ">=54.0.0",
+    "expo-sharing": ">=54.0.0",
     "expo-speech-recognition": ">=1.0.0",
     "react": ">=19",
     "react-native": ">=0.81",
     "react-native-gesture-handler": ">=2.20.0",
-    "react-native-reanimated": ">=3.0.0"
+    "react-native-reanimated": ">=3.0.0",
+    "react-native-view-shot": ">=4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@expo/vector-icons": {
+      "optional": true
+    },
+    "@forthtilliath/expo-release-updates-ui": {
+      "optional": true
+    },
+    "expo-calendar": {
+      "optional": true
+    },
+    "expo-file-system": {
+      "optional": true
+    },
+    "expo-haptics": {
+      "optional": true
+    },
+    "expo-image-manipulator": {
+      "optional": true
+    },
+    "expo-image-picker": {
+      "optional": true
+    },
+    "expo-sharing": {
+      "optional": true
+    },
+    "expo-speech-recognition": {
+      "optional": true
+    },
+    "react-native-gesture-handler": {
+      "optional": true
+    },
+    "react-native-reanimated": {
+      "optional": true
+    },
+    "react-native-view-shot": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@expo/vector-icons": "^15.1.1",
@@ -41,25 +85,32 @@
     "@types/react-test-renderer": "^19.1.0",
     "@vitest/coverage-v8": "5.0.2",
     "eslint": "10.7.0",
+    "expo-calendar": "~57.0.5",
+    "expo-file-system": "~57.0.2",
+    "expo-haptics": "~57.0.3",
+    "expo-image-manipulator": "~57.0.21",
     "expo-image-picker": "~57.0.9",
+    "expo-sharing": "~57.0.23",
     "expo-speech-recognition": "^56.0.1",
     "react": "^19.2.8",
     "react-native": "0.86.0",
     "react-native-gesture-handler": "~2.32.0",
     "react-native-reanimated": "4.5.1",
+    "react-native-view-shot": "5.1.0",
     "react-native-worklets": "0.10.1",
     "react-test-renderer": "19.2.3",
     "size-limit": "^14.1.0",
     "typescript": "^5.9.3",
     "vitest": "^5.0.2",
-    "@forthtilliath/eslint-config": "0.8.0",
-    "@forthtilliath/typescript-config": "0.1.1"
+    "@forthtilliath/eslint-config": "0.9.0",
+    "@forthtilliath/typescript-config": "0.1.1",
+    "@forthtilliath/expo-release-updates-ui": "^0.4.1"
   },
   "size-limit": [
     {
       "name": "dist (all modules, brotli)",
       "path": "dist/**/*.js",
-      "limit": "30 KB"
+      "limit": "44 KB"
     }
   ],
   "scripts": {