@codeleap/mobile 1.3.1 → 1.4.2

package/src/modules/types/documentPicker.d.ts

@@ -0,0 +1,215 @@
+import { ModalPropsIOS } from 'react-native'
+import type { PlatformTypes, SupportedPlatforms } from './fileTypes'
+
+export declare type DocumentPickerResponse = {
+        uri: string
+        name: string
+        copyError?: string
+        fileCopyUri: string | null
+        type: string | null
+        size: number | null
+    }
+export declare const types: Readonly<{
+        readonly allFiles: '*/*'
+        readonly audio: 'audio/*'
+        readonly csv: 'text/csv'
+        readonly doc: 'application/msword'
+        readonly docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+        readonly images: 'image/*'
+        readonly pdf: 'application/pdf'
+        readonly plainText: 'text/plain'
+        readonly ppt: 'application/vnd.ms-powerpoint'
+        readonly pptx: 'application/vnd.openxmlformats-officedocument.presentationml.presentation'
+        readonly video: 'video/*'
+        readonly xls: 'application/vnd.ms-excel'
+        readonly xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+        readonly zip: 'application/zip'
+    }> | Readonly<{
+        readonly allFiles: 'public.item'
+        readonly audio: 'public.audio'
+        readonly csv: 'public.comma-separated-values-text'
+        readonly doc: 'com.microsoft.word.doc'
+        readonly docx: 'org.openxmlformats.wordprocessingml.document'
+        readonly images: 'public.image'
+        readonly pdf: 'com.adobe.pdf'
+        readonly plainText: 'public.plain-text'
+        readonly ppt: 'com.microsoft.powerpoint.ppt'
+        readonly pptx: 'org.openxmlformats.presentationml.presentation'
+        readonly video: 'public.movie'
+        readonly xls: 'com.microsoft.excel.xls'
+        readonly xlsx: 'org.openxmlformats.spreadsheetml.sheet'
+        readonly zip: 'public.zip-archive'
+    }> | Readonly<{
+        readonly allFiles: '*'
+        readonly audio: '.3g2 .3gp .aac .adt .adts .aif .aifc .aiff .asf .au .m3u .m4a .m4b .mid .midi .mp2 .mp3 .mp4 .rmi .snd .wav .wax .wma'
+        readonly csv: '.csv'
+        readonly doc: '.doc'
+        readonly docx: '.docx'
+        readonly images: '.jpeg .jpg .png'
+        readonly pdf: '.pdf'
+        readonly plainText: '.txt'
+        readonly ppt: '.ppt'
+        readonly pptx: '.pptx'
+        readonly video: '.mp4'
+        readonly xls: '.xls'
+        readonly xlsx: '.xlsx'
+        readonly zip: '.zip .gz'
+    }>
+export declare type DirectoryPickerResponse = {
+        uri: string
+    }
+export declare type DocumentPickerOptions<OS extends SupportedPlatforms> = {
+        type?: string | PlatformTypes[OS][keyof PlatformTypes[OS]] | Array<PlatformTypes[OS][keyof PlatformTypes[OS]] | string>
+        mode?: 'import' | 'open'
+        copyTo?: 'cachesDirectory' | 'documentDirectory'
+        allowMultiSelection?: boolean
+    } & Pick<ModalPropsIOS, 'presentationStyle'>
+export declare function pickDirectory<
+    OS extends SupportedPlatforms>(params?: Pick<DocumentPickerOptions<OS>, 'presentationStyle'>): Promise<DirectoryPickerResponse | null>
+export declare function pickMultiple<OS extends SupportedPlatforms>(opts?: DocumentPickerOptions<OS>): Promise<DocumentPickerResponse[]>
+export declare function pickSingle<OS extends SupportedPlatforms>(opts?: DocumentPickerOptions<OS>): Promise<DocumentPickerResponse>
+export declare function pick<OS extends SupportedPlatforms>(opts?: DocumentPickerOptions<OS>): Promise<DocumentPickerResponse[]>
+export declare function releaseSecureAccess(uris: Array<string>): Promise<void>
+export declare type NativeModuleErrorShape = Error & {
+        code?: string
+    }
+export declare function isCancel(err: unknown): boolean
+export declare function isInProgress(err: unknown): boolean
+
+export type DocumentPicker = {
+        isCancel: typeof isCancel
+        releaseSecureAccess: typeof releaseSecureAccess
+        pickDirectory: typeof pickDirectory
+        pick: typeof pick
+        pickMultiple: typeof pickMultiple
+        pickSingle: typeof pickSingle
+        types: Readonly<{
+            readonly allFiles: '*/*'
+            readonly audio: 'audio/*'
+            readonly csv: 'text/csv'
+            readonly doc: 'application/msword'
+            readonly docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+            readonly images: 'image/*'
+            readonly pdf: 'application/pdf'
+            readonly plainText: 'text/plain'
+            readonly ppt: 'application/vnd.ms-powerpoint'
+            readonly pptx: 'application/vnd.openxmlformats-officedocument.presentationml.presentation'
+            readonly video: 'video/*'
+            readonly xls: 'application/vnd.ms-excel'
+            readonly xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+            readonly zip: 'application/zip'
+        }> | Readonly<{
+            readonly allFiles: 'public.item'
+            readonly audio: 'public.audio'
+            readonly csv: 'public.comma-separated-values-text'
+            readonly doc: 'com.microsoft.word.doc'
+            readonly docx: 'org.openxmlformats.wordprocessingml.document'
+            readonly images: 'public.image'
+            readonly pdf: 'com.adobe.pdf'
+            readonly plainText: 'public.plain-text'
+            readonly ppt: 'com.microsoft.powerpoint.ppt'
+            readonly pptx: 'org.openxmlformats.presentationml.presentation'
+            readonly video: 'public.movie'
+            readonly xls: 'com.microsoft.excel.xls'
+            readonly xlsx: 'org.openxmlformats.spreadsheetml.sheet'
+            readonly zip: 'public.zip-archive'
+        }> | Readonly<{
+            readonly allFiles: '*'
+            readonly audio: '.3g2 .3gp .aac .adt .adts .aif .aifc .aiff .asf .au .m3u .m4a .m4b .mid .midi .mp2 .mp3 .mp4 .rmi .snd .wav .wax .wma'
+            readonly csv: '.csv'
+            readonly doc: '.doc'
+            readonly docx: '.docx'
+            readonly images: '.jpeg .jpg .png'
+            readonly pdf: '.pdf'
+            readonly plainText: '.txt'
+            readonly ppt: '.ppt'
+            readonly pptx: '.pptx'
+            readonly video: '.mp4'
+            readonly xls: '.xls'
+            readonly xlsx: '.xlsx'
+            readonly zip: '.zip .gz'
+        }>
+        perPlatformTypes: {
+            android: Readonly<{
+                readonly allFiles: '*/*'
+                readonly audio: 'audio/*'
+                readonly csv: 'text/csv'
+                readonly doc: 'application/msword'
+                readonly docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+                readonly images: 'image/*'
+                readonly pdf: 'application/pdf'
+                readonly plainText: 'text/plain'
+                readonly ppt: 'application/vnd.ms-powerpoint'
+                readonly pptx: 'application/vnd.openxmlformats-officedocument.presentationml.presentation'
+                readonly video: 'video/*'
+                readonly xls: 'application/vnd.ms-excel'
+                readonly xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+                readonly zip: 'application/zip'
+            }>
+            ios: Readonly<{
+                readonly allFiles: 'public.item'
+                readonly audio: 'public.audio'
+                readonly csv: 'public.comma-separated-values-text'
+                readonly doc: 'com.microsoft.word.doc'
+                readonly docx: 'org.openxmlformats.wordprocessingml.document'
+                readonly images: 'public.image'
+                readonly pdf: 'com.adobe.pdf'
+                readonly plainText: 'public.plain-text'
+                readonly ppt: 'com.microsoft.powerpoint.ppt'
+                readonly pptx: 'org.openxmlformats.presentationml.presentation'
+                readonly video: 'public.movie'
+                readonly xls: 'com.microsoft.excel.xls'
+                readonly xlsx: 'org.openxmlformats.spreadsheetml.sheet'
+                readonly zip: 'public.zip-archive'
+            }>
+            windows: Readonly<{
+                readonly allFiles: '*'
+                readonly audio: '.3g2 .3gp .aac .adt .adts .aif .aifc .aiff .asf .au .m3u .m4a .m4b .mid .midi .mp2 .mp3 .mp4 .rmi .snd .wav .wax .wma'
+                readonly csv: '.csv'
+                readonly doc: '.doc'
+                readonly docx: '.docx'
+                readonly images: '.jpeg .jpg .png'
+                readonly pdf: '.pdf'
+                readonly plainText: '.txt'
+                readonly ppt: '.ppt'
+                readonly pptx: '.pptx'
+                readonly video: '.mp4'
+                readonly xls: '.xls'
+                readonly xlsx: '.xlsx'
+                readonly zip: '.zip .gz'
+            }>
+            macos: Readonly<{
+                readonly allFiles: '*'
+                readonly audio: '.3g2 .3gp .aac .adt .adts .aif .aifc .aiff .asf .au .m3u .m4a .m4b .mid .midi .mp2 .mp3 .mp4 .rmi .snd .wav .wax .wma'
+                readonly csv: '.csv'
+                readonly doc: '.doc'
+                readonly docx: '.docx'
+                readonly images: '.jpeg .jpg .png'
+                readonly pdf: '.pdf'
+                readonly plainText: '.txt'
+                readonly ppt: '.ppt'
+                readonly pptx: '.pptx'
+                readonly video: '.mp4'
+                readonly xls: '.xls'
+                readonly xlsx: '.xlsx'
+                readonly zip: '.zip .gz'
+            }>
+            web: Readonly<{
+                readonly allFiles: '*'
+                readonly audio: '.3g2 .3gp .aac .adt .adts .aif .aifc .aiff .asf .au .m3u .m4a .m4b .mid .midi .mp2 .mp3 .mp4 .rmi .snd .wav .wax .wma'
+                readonly csv: '.csv'
+                readonly doc: '.doc'
+                readonly docx: '.docx'
+                readonly images: '.jpeg .jpg .png'
+                readonly pdf: '.pdf'
+                readonly plainText: '.txt'
+                readonly ppt: '.ppt'
+                readonly pptx: '.pptx'
+                readonly video: '.mp4'
+                readonly xls: '.xls'
+                readonly xlsx: '.xlsx'
+                readonly zip: '.zip .gz'
+            }>
+        }
+    }
+

package/src/modules/types/fileTypes.ts

@@ -0,0 +1,138 @@
+declare const mimeTypes: Readonly<{
+    readonly allFiles: '*/*'
+    readonly audio: 'audio/*'
+    readonly csv: 'text/csv'
+    readonly doc: 'application/msword'
+    readonly docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+    readonly images: 'image/*'
+    readonly pdf: 'application/pdf'
+    readonly plainText: 'text/plain'
+    readonly ppt: 'application/vnd.ms-powerpoint'
+    readonly pptx: 'application/vnd.openxmlformats-officedocument.presentationml.presentation'
+    readonly video: 'video/*'
+    readonly xls: 'application/vnd.ms-excel'
+    readonly xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+    readonly zip: 'application/zip'
+}>
+declare const utis: Readonly<{
+    readonly allFiles: 'public.item'
+    readonly audio: 'public.audio'
+    readonly csv: 'public.comma-separated-values-text'
+    readonly doc: 'com.microsoft.word.doc'
+    readonly docx: 'org.openxmlformats.wordprocessingml.document'
+    readonly images: 'public.image'
+    readonly pdf: 'com.adobe.pdf'
+    readonly plainText: 'public.plain-text'
+    readonly ppt: 'com.microsoft.powerpoint.ppt'
+    readonly pptx: 'org.openxmlformats.presentationml.presentation'
+    readonly video: 'public.movie'
+    readonly xls: 'com.microsoft.excel.xls'
+    readonly xlsx: 'org.openxmlformats.spreadsheetml.sheet'
+    readonly zip: 'public.zip-archive'
+}>
+declare const extensions: Readonly<{
+    readonly allFiles: '*'
+    readonly audio: '.3g2 .3gp .aac .adt .adts .aif .aifc .aiff .asf .au .m3u .m4a .m4b .mid .midi .mp2 .mp3 .mp4 .rmi .snd .wav .wax .wma'
+    readonly csv: '.csv'
+    readonly doc: '.doc'
+    readonly docx: '.docx'
+    readonly images: '.jpeg .jpg .png'
+    readonly pdf: '.pdf'
+    readonly plainText: '.txt'
+    readonly ppt: '.ppt'
+    readonly pptx: '.pptx'
+    readonly video: '.mp4'
+    readonly xls: '.xls'
+    readonly xlsx: '.xlsx'
+    readonly zip: '.zip .gz'
+}>
+export declare type PlatformTypes = {
+    android: typeof mimeTypes
+    ios: typeof utis
+    windows: typeof extensions
+}
+export declare type SupportedPlatforms = 'ios' | 'android' | 'windows'
+export declare const perPlatformTypes: {
+    android: Readonly<{
+        readonly allFiles: '*/*'
+        readonly audio: 'audio/*'
+        readonly csv: 'text/csv'
+        readonly doc: 'application/msword'
+        readonly docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+        readonly images: 'image/*'
+        readonly pdf: 'application/pdf'
+        readonly plainText: 'text/plain'
+        readonly ppt: 'application/vnd.ms-powerpoint'
+        readonly pptx: 'application/vnd.openxmlformats-officedocument.presentationml.presentation'
+        readonly video: 'video/*'
+        readonly xls: 'application/vnd.ms-excel'
+        readonly xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+        readonly zip: 'application/zip'
+    }>
+    ios: Readonly<{
+        readonly allFiles: 'public.item'
+        readonly audio: 'public.audio'
+        readonly csv: 'public.comma-separated-values-text'
+        readonly doc: 'com.microsoft.word.doc'
+        readonly docx: 'org.openxmlformats.wordprocessingml.document'
+        readonly images: 'public.image'
+        readonly pdf: 'com.adobe.pdf'
+        readonly plainText: 'public.plain-text'
+        readonly ppt: 'com.microsoft.powerpoint.ppt'
+        readonly pptx: 'org.openxmlformats.presentationml.presentation'
+        readonly video: 'public.movie'
+        readonly xls: 'com.microsoft.excel.xls'
+        readonly xlsx: 'org.openxmlformats.spreadsheetml.sheet'
+        readonly zip: 'public.zip-archive'
+    }>
+    windows: Readonly<{
+        readonly allFiles: '*'
+        readonly audio: '.3g2 .3gp .aac .adt .adts .aif .aifc .aiff .asf .au .m3u .m4a .m4b .mid .midi .mp2 .mp3 .mp4 .rmi .snd .wav .wax .wma'
+        readonly csv: '.csv'
+        readonly doc: '.doc'
+        readonly docx: '.docx'
+        readonly images: '.jpeg .jpg .png'
+        readonly pdf: '.pdf'
+        readonly plainText: '.txt'
+        readonly ppt: '.ppt'
+        readonly pptx: '.pptx'
+        readonly video: '.mp4'
+        readonly xls: '.xls'
+        readonly xlsx: '.xlsx'
+        readonly zip: '.zip .gz'
+    }>
+    macos: Readonly<{
+        readonly allFiles: '*'
+        readonly audio: '.3g2 .3gp .aac .adt .adts .aif .aifc .aiff .asf .au .m3u .m4a .m4b .mid .midi .mp2 .mp3 .mp4 .rmi .snd .wav .wax .wma'
+        readonly csv: '.csv'
+        readonly doc: '.doc'
+        readonly docx: '.docx'
+        readonly images: '.jpeg .jpg .png'
+        readonly pdf: '.pdf'
+        readonly plainText: '.txt'
+        readonly ppt: '.ppt'
+        readonly pptx: '.pptx'
+        readonly video: '.mp4'
+        readonly xls: '.xls'
+        readonly xlsx: '.xlsx'
+        readonly zip: '.zip .gz'
+    }>
+    web: Readonly<{
+        readonly allFiles: '*'
+        readonly audio: '.3g2 .3gp .aac .adt .adts .aif .aifc .aiff .asf .au .m3u .m4a .m4b .mid .midi .mp2 .mp3 .mp4 .rmi .snd .wav .wax .wma'
+        readonly csv: '.csv'
+        readonly doc: '.doc'
+        readonly docx: '.docx'
+        readonly images: '.jpeg .jpg .png'
+        readonly pdf: '.pdf'
+        readonly plainText: '.txt'
+        readonly ppt: '.ppt'
+        readonly pptx: '.pptx'
+        readonly video: '.mp4'
+        readonly xls: '.xls'
+        readonly xlsx: '.xlsx'
+        readonly zip: '.zip .gz'
+    }>
+}
+export declare const typesAreEqual: true
+export {}

package/src/types/utility.ts

@@ -1,3 +1,3 @@
-import { StyleProp } from "react-native";
-
-export type StylesOf<C extends string> = Partial<Record<C, StyleProp<any>> >
+import { StyleProp } from 'react-native'
+
+export type StylesOf<C extends string> = Partial<Record<C, StyleProp<any>>>

package/src/utils/OSAlert.ts

@@ -1,122 +1,180 @@
-/* eslint no-restricted-imports: 'off' */
-import { Alert, AlertButton } from 'react-native'
-
-
-/**
- * Alert.{function} receives three parameters, the last one being an object:
- *
- * @param {string} title text to appear in title
- * @param {string} body text to appear in body
- * @param {object} options array of buttons and callbacks
- *
- * options properties
- * @property {string} name object description
- * @property {function} run callback function to run on press
- */
-
-type NativeAlertArgs = Parameters<typeof Alert.alert>
-
-type OSAlertArgs = {
-    title:NativeAlertArgs['0'],
-    body?: NativeAlertArgs['1']
-    options?: NativeAlertArgs['2']
-}
-type AlertEvent = AlertButton['onPress']
-
-type NamedEvents<E extends string> = Partial<Record<E, AlertEvent>>
-
-function ask({ title, body, options = null }:OSAlertArgs) {
-
-  if (!title) {
-    title = 'Quick quetion'
-  }
-  OSAlert({
-    title,
-    body,
-    options,
-  })
-}
-
-function warn({ title, body, onAccept, onReject }:OSAlertArgs & NamedEvents<'onReject'|'onAccept'>) {
-  
-  if (!title) {
-    title = 'Hang on'
-  }
-  if (!body) {
-    body = 'Are you sure?'
-  }
-  if (!onReject) {
-    onReject = () => null
-  }
-  OSAlert({
-    title,
-    body,
-    options: [
-      {
-        text: 'Cancel',
-        onPress:onReject,
-      },
-      {
-        text: 'OK',
-        style: 'destructive',
-        onPress: onAccept,
-      },
-    ],
-  })
-}
-
-function info({ title, body, onDismiss = () => null }:OSAlertArgs & NamedEvents<'onDismiss'>) {
-
-  if (!title) {
-    title = 'FYI'
-  }
-  OSAlert({
-    title,
-    body,
-    options: [
-      {
-        text: 'OK',
-        onPress:onDismiss,
-      },
-    ],
-  })
-}
-
-function OSError({ title, body, onDismiss = () => null }:OSAlertArgs & NamedEvents<'onDismiss'>) {
-  if (!title) {
-    title = 'Whoops!'
-  }
-  if (!body) {
-    body = 'Something went wrong'
-  }
-  OSAlert({
-    title,
-    body,
-    options: [
-      {
-        text: 'OK',
-        onPress: () => onDismiss(),
-      },
-    ],
-  })
-}
-
-function OSAlert(params:OSAlertArgs) {
-  Alert.alert(
-    params.title,
-    params.body,
-    params.options,
-    {
-      cancelable: false,
-    },
-  )
-}
-
-
-export default {
-    ask,
-    warn,
-    info,
-    error: OSError,
-  }
-  
+/* eslint no-restricted-imports: 'off' */
+/* eslint prefer-const: 'off' */
+import { Alert, AlertButton } from 'react-native'
+
+/**
+ * Alert.{function} receives three parameters, the last one being an object:
+ *
+ * @param {string} title text to appear in title
+ * @param {string} body text to appear in body
+ * @param {object} options array of buttons and callbacks
+ *
+ * options properties
+ * @property {string} name object description
+ * @property {function} run callback function to run on press
+ */
+
+type NativeAlertArgs = Parameters<typeof Alert.alert>
+
+type OSAlertArgs = {
+  title: NativeAlertArgs['0']
+  body?: NativeAlertArgs['1']
+  options?: NativeAlertArgs['2']
+}
+type AlertEvent = AlertButton['onPress']
+type OSAlertType = 'info' | 'error' | 'warn' | 'ask'
+type NamedEvents<E extends string> = Partial<Record<E, AlertEvent>>
+
+const currentAlerts = {
+
+}
+
+function generateAlertID(from:OSAlertArgs & {type: OSAlertType}) {
+  return [
+    from.type,
+    from.title,
+    from.body,
+  ].join('-')
+}
+
+function shouldShowAlert(args:OSAlertArgs, type: OSAlertType) {
+  const alertId = generateAlertID({ ...args, type })
+
+  if (!Object.keys(currentAlerts).includes(alertId)) {
+    currentAlerts[alertId] = true
+
+    return alertId
+  }
+
+  return ''
+}
+
+function popAlert(id:string) {
+  delete currentAlerts[id]
+}
+
+function ask({ title, body, options = null }: OSAlertArgs) {
+  if (!title) {
+    title = 'Quick quetion'
+  }
+  OSAlert({
+    title,
+    body,
+    options,
+  })
+}
+
+function warn(args: OSAlertArgs & NamedEvents<'onReject' | 'onAccept'>) {
+  const id = shouldShowAlert(args, 'warn')
+
+  if (!id) return
+  let {
+    title,
+    body,
+    onAccept,
+    onReject,
+  } = args
+
+  if (!title) {
+    title = 'Hang on'
+  }
+  if (!body) {
+    body = 'Are you sure?'
+  }
+  if (!onReject) {
+    onReject = () => null
+  }
+  OSAlert({
+    title,
+    body,
+    options: [
+      {
+        text: 'Cancel',
+        onPress: () => {
+          popAlert(id)
+          onReject()
+        },
+      },
+      {
+        text: 'OK',
+        style: 'destructive',
+        onPress: () => {
+          popAlert(id)
+          onAccept?.()
+        },
+      },
+    ],
+  })
+}
+
+function info(args: OSAlertArgs & NamedEvents<'onDismiss'>) {
+  const id = shouldShowAlert(args, 'info')
+
+  if (!id) return
+  let {
+    title,
+    body,
+    onDismiss = () => null,
+  } = args
+
+  if (!title) {
+    title = 'FYI'
+  }
+  OSAlert({
+    title,
+    body,
+    options: [
+      {
+        text: 'OK',
+        onPress: () => {
+          popAlert(id)
+          onDismiss?.()
+        },
+      },
+    ],
+  })
+}
+
+function OSError(args: OSAlertArgs & NamedEvents<'onDismiss'>) {
+  const id = shouldShowAlert(args, 'error')
+
+  if (!id) return
+
+  let {
+    title,
+    body,
+  } = args
+
+  if (!title) {
+    title = 'Whoops!'
+  }
+  if (!body) {
+    body = 'Something went wrong'
+  }
+  OSAlert({
+    title,
+    body,
+    options: [
+      {
+        text: 'OK',
+        onPress: () => {
+          popAlert(id)
+          args?.onDismiss?.()
+        },
+      },
+    ],
+  })
+}
+
+function OSAlert(params: OSAlertArgs) {
+  Alert.alert(params.title, params.body, params.options, {
+    cancelable: false,
+  })
+}
+
+export default {
+  ask,
+  warn,
+  info,
+  error: OSError,
+}