waha-shared 1.0.1 → 1.0.2

package/data/typescript/languages.ts

@@ -1,369 +0,0 @@
-import { z } from 'zod'
-
-export const languages = z.array(
-  z
-    .object({
-      languageId: z
-        .string()
-        .describe(
-          "A 3 letter id used to represent a language in Waha. Use the standard ISO 693-3 id found in data/iso6933LanguageCodes.json. If the language isn't there, use a unique custom 3 letter id that isn't already taken and add it to that file so it doesn't get taken by another language."
-        ),
-      exonym: z
-        .string()
-        .describe(
-          'The name of a language in English, i.e. "Spanish". This helps Waha team members identify the language.'
-        ),
-      appInterface: z.boolean(),
-      bcpLanguageId: z
-        .string()
-        .describe(
-          "A language ID used for iOS's screen reader support. Should be in BCP 47 format. Should only be included if language is supported by iOS's screen reader. List of supported languages can be found here: https://www.apple.com/ios/feature-availability/"
-        )
-        .optional(),
-      bible: z
-        .string()
-        .describe(
-          'Determines what scripture translation this language will use.'
-        )
-        .optional(),
-      bibleFallback: z
-        .string()
-        .describe(
-          "Bible to use as a fallback if a chapter isn't available in the main bible. For example, if a language has only an NT bible available, specify a translation that has the OT available here to use for OT passages."
-        )
-        .optional(),
-      countries: z
-        .array(z.string())
-        .describe(
-          "A list of country ids that this language is spoken in. This gets added automatically by the script found in scripts/mapCountriesToLanguages.ts which uses shared/data/languageResources/countriesAndLanguages.json to generate a list of countries where the language is spoken. This is used for determing the recommended list of meet languages based on the user's country location."
-        )
-        .optional(),
-      crowdinId: z
-        .string()
-        .describe(
-          "The Id of this language in Crowdin. For language's that crowdin supports, this can be found in <https://developer.crowdin.com/language-codes>. Otherwise, it will be a custom id created at the time the language was added to crowdin."
-        )
-        .optional(),
-      curriculum: z
-        .object({
-          foundations: z
-            .string()
-            .describe(
-              'The id for the foundations curriculum for this language.'
-            ),
-          questions: z
-            .string()
-            .describe(
-              'The id for the foundations curriculum for this language.'
-            ),
-          topics: z
-            .union([z.string(), z.null()])
-            .describe(
-              'The id for the foundations curriculum for this language.'
-            ),
-        })
-        .strict()
-        .describe(
-          'Determines what curriculums this language will use for its various content. Each must be linked to objects in data/foundationsCurriculums.json, data/topicsCurriculums.json , or data/questionsCurriculums.json.'
-        ),
-      dmCourseStatus: z
-        .enum(['notStarted', 'inProgress', 'testing', 'launched'])
-        .describe("The status of this language's disciple making course."),
-      endonym: z
-        .string()
-        .regex(new RegExp('^.+$'))
-        .describe(
-          'The name of the language in its native language and script, e.g. "Español"'
-        )
-        .optional(),
-      gdmcStatus: z
-        .enum(['notStarted', 'inProgress', 'testing', 'launched'])
-        .describe("The status of this language's growing as a dmc sets."),
-      givingId: z
-        .string()
-        .describe(
-          "This is a designation id with FundraiseUp that will be tacked onto the end of waha's giving url. It's used to open waha's giving page and designate the donation to this language. It can be found in the big table of designation ids here: https://dashboard.fundraiseup.com/ABJRDUBH/settings/designations"
-        )
-        .optional(),
-      hideDonateButton: z
-        .boolean()
-        .describe(
-          'Whether or not to hide the donate button in the app when this language is selected as the meet language.'
-        )
-        .optional(),
-      introBridge: z
-        .string()
-        .describe(
-          'The language id of the language that will be used as the bridge language for the intro content.'
-        )
-        .optional(),
-      likelyAppInterfacePair: z
-        .string()
-        .describe(
-          'The language id of the language that is most likely to be used as the app interface language for this language.'
-        )
-        .optional(),
-      mmsLanguageId: z
-        .string()
-        .describe(
-          'Id of a supported MMS language for running forced alignment.'
-        )
-        .optional(),
-      notes: z
-        .string()
-        .describe(
-          'Any notes about this language that might be helpful for Waha team members.'
-        )
-        .optional(),
-      pm: z
-        .string()
-        .describe(
-          "The id of the project manager for this language. This is the person who is responsible for the language's content and progress."
-        )
-        .optional(),
-      questionSource: z
-        .enum(['recorded', 'mms', 'elevenLabs', 'unknown'])
-        .describe(
-          'The source for question audio generation for this language.'
-        ),
-      script: z
-        .enum([
-          'arabic',
-          'bengali',
-          'burmese',
-          'chinese',
-          'cyrillic',
-          'devanagari',
-          'geez',
-          'georgian',
-          'greek',
-          'gujarati',
-          'gurmukhi',
-          'hebrew',
-          'japanese',
-          'kannada',
-          'khmer',
-          'korean',
-          'latin',
-          'malayalam',
-          'tamil',
-          'telugu',
-          'thai',
-          'uyghur',
-        ])
-        .describe(
-          'The script that a language uses. Each script has a specific font so that we can display all scripts correctly.'
-        ),
-      speakersPrimary: z
-        .number()
-        .describe(
-          'The number of speakers of this language who speak it as their first language.'
-        )
-        .optional(),
-      speakersSecondary: z
-        .number()
-        .describe(
-          'The number of speakers of this language who speak it as a second language.'
-        )
-        .optional(),
-      speakersTotal: z
-        .number()
-        .describe('The total number of speakers of this language worldwide.')
-        .optional(),
-      specialThanks: z.any().optional(),
-      status: z
-        .enum(['notStarted', 'inProgress', 'testing', 'launched'])
-        .describe(
-          "The overall status of this language. Determines whether or not the language will show up in the app. Only language's marked `launched` will be selectable in Waha."
-        ),
-      storeIdAndroid: z
-        .enum([
-          'af',
-          'sq',
-          'am',
-          'ar',
-          'hy-AM',
-          'az-AZ',
-          'bn-BD',
-          'eu-ES',
-          'be',
-          'bg',
-          'my-MM',
-          'ca',
-          'zh-HK',
-          'zh-CN',
-          'zh-TW',
-          'hr',
-          'cs-CZ',
-          'da-DK',
-          'nl-NL',
-          'en-AU',
-          'en-CA',
-          'en-GB',
-          'en-IN',
-          'en-SG',
-          'en-US',
-          'en-ZA',
-          'et',
-          'fil',
-          'fi-FI',
-          'fr-CA',
-          'fr-FR',
-          'gl-ES',
-          'ka-GE',
-          'de-DE',
-          'el-GR',
-          'gu',
-          'iw-IL',
-          'hi-IN',
-          'hu-HU',
-          'is-IS',
-          'id',
-          'it-IT',
-          'ja-JP',
-          'kn-IN',
-          'kk',
-          'km-KH',
-          'ko-KR',
-          'ky-KG',
-          'lo-LA',
-          'lv',
-          'lt',
-          'mk-MK',
-          'ms-MY',
-          'ms',
-          'ml-IN',
-          'mr-IN',
-          'mn-MN',
-          'ne-NP',
-          'no-NO',
-          'fa',
-          'fa-AE',
-          'fa-AF',
-          'fa-IR',
-          'pl-PL',
-          'pt-BR',
-          'pt-PT',
-          'pa',
-          'ro',
-          'rm',
-          'ru-RU',
-          'sr',
-          'si-LK',
-          'sk',
-          'sl',
-          'es-419',
-          'es-ES',
-          'es-US',
-          'sw',
-          'sv-SE',
-          'ta-IN',
-          'te-IN',
-          'th',
-          'tr-TR',
-          'uk',
-          'ur',
-          'vi',
-          'zu',
-        ])
-        .describe(
-          "The id of this language in the play store, if it's supported.\nAfrikaans:af\nAlbanian:sq\nAmharic:am\nArabic:ar\nArmenian:hy-AM\nAzerbaijani:az-AZ\nBangla:bn-BD\nBasque:eu-ES\nBelarusian:be\nBulgarian:bg\nBurmese:my-MM\nCatalan:ca\nChinese (Hong Kong):zh-HK\nChinese (Simplified):zh-CN\nChinese (Traditional):zh-TW\nCroatian:hr\nCzech:cs-CZ\nDanish:da-DK\nDutch:nl-NL\nEnglish (Australia):en-AU\nEnglish (Canada):en-CA\nEnglish (United Kingdom):en-GB\nEnglish:en-IN\nEnglish (US):en-US\nEnglish:en-SG\nEnglish:en-ZA\nEstonian:et\nFilipino:fil\nFinnish:fi-FI\nFrench (Canada):fr-CA\nFrench (France):fr-FR\nGalician:gl-ES\nGeorgian:ka-GE\nGerman:de-DE\nGreek:el-GR\nGujarati:gu\nHebrew:iw-IL\nHindi:hi-IN\nHungarian:hu-HU\nIcelandic:is-IS\nIndonesian:id\nItalian:it-IT\nJapanese:ja-JP\nKannada:kn-IN\nKazakh:kk\nKhmer:km-KH\nKorean:ko-KR\nKyrgyz:ky-KG\nLao:lo-LA\nLatvian:lv\nLithuanian:lt\nMacedonian:mk-MK\nMalay (Malaysia):ms-MY\nMalay:ms\nMalayalam:ml-IN\nMarathi:mr-IN\nMongolian:mn-MN\nNepali:ne-NP\nNorwegian:no-NO\nPersian:fa\nPersian:fa-AE\nPersian:fa-AF\nPersian:fa-IR\nPolish:pl-PL\nPortuguese (Brazil):pt-BR\nPortuguese (Portugal):pt-PT\nPunjabi:pa\nRomanian:ro\nRomansh:rm\nRussian:ru-RU\nSerbian:sr\nSinhala:si-LK\nSlovak:sk\nSlovenian:sl\nSpanish (Latin America):es-419\nSpanish (Spain):es-ES\nSpanish (United States):es-US\nSwahili:sw\nSwedish:sv-SE\nTamil:ta-IN\nTelugu:te-IN\nThai:th\nTurkish:tr-TR\nUkrainian:uk\nUrdu:ur\nVietnamese:vi\nZulu:zu"
-        )
-        .optional(),
-      storeIdIos: z
-        .enum([
-          'ar-SA',
-          'ca',
-          'cs',
-          'da',
-          'de-DE',
-          'el',
-          'en-AU',
-          'en-CA',
-          'en-GB',
-          'en-US',
-          'es-ES',
-          'es-MX',
-          'fi',
-          'fr-CA',
-          'fr-FR',
-          'he',
-          'hi',
-          'hr',
-          'hu',
-          'id',
-          'it',
-          'ja',
-          'ko',
-          'ms',
-          'nl-NL',
-          'no',
-          'pl',
-          'pt-BR',
-          'pt-PT',
-          'ro',
-          'ru',
-          'sk',
-          'sv',
-          'th',
-          'tr',
-          'uk',
-          'vi',
-          'zh-Hans',
-          'zh-Hant',
-        ])
-        .describe(
-          "The id of this language in the app store, if it's supported.\nArabic:ar-SA\nCatalan:ca\nChinese (Simplified):zh-Hans\nChinese (Traditional):zh-Hant\nCroatian:hr\nCzech:cs\nDanish:da\nDutch:nl-NL\nEnglish (Australia):en-AU\nEnglish (Canada):en-CA\nEnglish (U.K.):en-GB\nEnglish (U.S.):en-US\nFinnish:fi\nFrench:fr-FR\nFrench (Canada):fr-CA\nGerman:de-DE\nGreek:el\nHebrew:he\nHindi:hi\nHungarian:hu\nIndonesian:id\nItalian:it\nJapanese:ja\nKorean:ko\nMalay:ms\nNorwegian:no \nPolish:pl\nPortuguese (Brazil):pt-BR\nPortuguese (Portugal):pt-PT\nRomanian:ro\nRussian:ru\nSlovak:sk\nSpanish (Mexico):es-MX\nSpanish (Spain):es-ES\nSwedish:sv\nThai:th\nTurkish:tr\nUkrainian:uk\nVietnamese:vi"
-        )
-        .optional(),
-      supportsSolarSpeakers: z
-        .boolean()
-        .describe('Whether or not this language supports solar speakers.')
-        .optional(),
-      titles: z
-        .string()
-        .describe(
-          "This is the language of the language's story set and lesson titles. Often, this will be the same as the language itself. Occasionally, this is not the case, such as all of the Arabic languages using standard Arabic as their titles language."
-        )
-        .optional(),
-      unsupportedDbsSets: z
-        .array(z.string())
-        .describe(
-          'A list of foundations or topics (01.x or 02.x) set ids that are not supported in this language. See data/sets.json for a list of set ids.'
-        )
-        .optional(),
-      uuid: z
-        .string()
-        .describe(
-          'A unique identifier for this language. Can be generated at <https://www.uuidgenerator.net>.'
-        ),
-      videoBridgeLanguage: z
-        .string()
-        .describe(
-          "If the language is not doing the dmc videos, or if the dmc videos are in progress, you can specify one or more bridge languages that will be used in the meantime. If a language does not have a launched dm course and if they don't specify any bridge languages, the training content will not be available in the app."
-        )
-        .optional(),
-      web: z
-        .object({
-          name: z
-            .string()
-            .describe(
-              "The name of the language to display in the website's language switcher."
-            ),
-          code: z
-            .string()
-            .describe(
-              "The html standard code used to represent the language on the web. Allows the website to associate the user's browser language with this Waha language."
-            ),
-          status: z
-            .enum(['notStarted', 'inProgress', 'testing', 'launched'])
-            .describe(
-              "The status of this language's website localization on https://waha.app."
-            ),
-        })
-        .strict()
-        .optional(),
-    })
-    .strict()
-)
-export type Languages = z.infer<typeof languages>

package/data/typescript/mediaDurations.ts

@@ -1,89 +0,0 @@
-import { z } from 'zod'
-
-export const mediaDurations = z
-  .record(
-    z.union([
-      z
-        .object({
-          questions: z.record(
-            z
-              .number()
-              .gte(0)
-              .describe('Duration of question audio file in seconds')
-          ),
-          ftbs: z.record(
-            z.number().gte(0).describe('Duration of ftb audio file in seconds')
-          ),
-          lessons: z.record(
-            z
-              .number()
-              .gte(0)
-              .describe('Duration of lesson audio file in seconds')
-          ),
-        })
-        .strict()
-        .describe(
-          'Language code (3-letter ISO code) containing media file durations'
-        ),
-      z.never(),
-    ])
-  )
-  .superRefine((value, ctx) => {
-    for (const key in value) {
-      let evaluated = false
-      if (key.match(new RegExp('^[a-z]{3}$'))) {
-        evaluated = true
-        const result = z
-          .object({
-            questions: z.record(
-              z
-                .number()
-                .gte(0)
-                .describe('Duration of question audio file in seconds')
-            ),
-            ftbs: z.record(
-              z
-                .number()
-                .gte(0)
-                .describe('Duration of ftb audio file in seconds')
-            ),
-            lessons: z.record(
-              z
-                .number()
-                .gte(0)
-                .describe('Duration of lesson audio file in seconds')
-            ),
-          })
-          .strict()
-          .describe(
-            'Language code (3-letter ISO code) containing media file durations'
-          )
-          .safeParse(value[key])
-        if (!result.success) {
-          ctx.addIssue({
-            path: [...ctx.path, key],
-            code: 'custom',
-            message: `Invalid input: Key matching regex /${key}/ must match schema`,
-            params: {
-              issues: result.error.issues,
-            },
-          })
-        }
-      }
-      if (!evaluated) {
-        const result = z.never().safeParse(value[key])
-        if (!result.success) {
-          ctx.addIssue({
-            path: [...ctx.path, key],
-            code: 'custom',
-            message: `Invalid input: must match catchall schema`,
-            params: {
-              issues: result.error.issues,
-            },
-          })
-        }
-      }
-    }
-  })
-  .describe('Schema for media duration data organized by language code')
-export type MediaDurations = z.infer<typeof mediaDurations>

package/data/typescript/notification.ts

@@ -1,189 +0,0 @@
-import { z } from 'zod'
-
-export const notification = z
-  .object({
-    title: z
-      .record(z.union([z.string(), z.never()]))
-      .superRefine((value, ctx) => {
-        for (const key in value) {
-          let evaluated = false
-          if (key.match(new RegExp('^[a-z]{3}$'))) {
-            evaluated = true
-            const result = z.string().safeParse(value[key])
-            if (!result.success) {
-              ctx.addIssue({
-                path: [...ctx.path, key],
-                code: 'custom',
-                message: `Invalid input: Key matching regex /${key}/ must match schema`,
-                params: {
-                  issues: result.error.issues,
-                },
-              })
-            }
-          }
-          if (!evaluated) {
-            const result = z.never().safeParse(value[key])
-            if (!result.success) {
-              ctx.addIssue({
-                path: [...ctx.path, key],
-                code: 'custom',
-                message: `Invalid input: must match catchall schema`,
-                params: {
-                  issues: result.error.issues,
-                },
-              })
-            }
-          }
-        }
-      }),
-    body: z
-      .record(z.union([z.string(), z.never()]))
-      .superRefine((value, ctx) => {
-        for (const key in value) {
-          let evaluated = false
-          if (key.match(new RegExp('^[a-z]{3}$'))) {
-            evaluated = true
-            const result = z.string().safeParse(value[key])
-            if (!result.success) {
-              ctx.addIssue({
-                path: [...ctx.path, key],
-                code: 'custom',
-                message: `Invalid input: Key matching regex /${key}/ must match schema`,
-                params: {
-                  issues: result.error.issues,
-                },
-              })
-            }
-          }
-          if (!evaluated) {
-            const result = z.never().safeParse(value[key])
-            if (!result.success) {
-              ctx.addIssue({
-                path: [...ctx.path, key],
-                code: 'custom',
-                message: `Invalid input: must match catchall schema`,
-                params: {
-                  issues: result.error.issues,
-                },
-              })
-            }
-          }
-        }
-      }),
-    actionUrl: z
-      .string()
-      .regex(new RegExp('^(https://|waha://).+$'))
-      .describe(
-        "Where to navigate to when a user clicks the CTA. If a waha web url is given, the link will navigate to a screen in the app. If not, it will open an in-app browser.\n@example\n// Would navigate to the English DM course in the app.\n'https://web.waha.app/set?set-id=03.009&meet-language=eng'\n@example\n// Would open up the in-app browser to the waha giving page.\n'https://waha.app/give-from-app?form=give'"
-      )
-      .optional(),
-    countriesToNotSendTo: z
-      .array(z.string())
-      .describe(
-        'Users in any country EXCEPT these will receive the notification. Cannot be defined with `countriesToSendTo`.'
-      )
-      .optional(),
-    countriesToSendTo: z
-      .array(z.string())
-      .describe(
-        "Only users who have logged activity in the specified countries will receive the notification. To send to users in all countries, don't include this key. Cannot be defined with `countriesToNotSendTo`."
-      )
-      .optional(),
-    faithJourney: z
-      .enum(['all', 'seekers', 'believers'])
-      .describe(
-        'Only users who match the specified faith journey status will receive the notification. To send to all users regardless of faith journey, use "all".'
-      )
-      .optional(),
-    imageUrl: z.string().regex(new RegExp('^https://.+$')).optional(),
-    meetLanguages: z
-      .union([z.literal('all'), z.array(z.string())])
-      .describe(
-        'Only users who have the specified meet languages as favorites will receive the notification. To send to users across all meet languages, use "all".'
-      )
-      .optional(),
-    minCompletions: z.number().int().optional(),
-    pushBody: z
-      .record(z.union([z.string(), z.never()]))
-      .superRefine((value, ctx) => {
-        for (const key in value) {
-          let evaluated = false
-          if (key.match(new RegExp('^[a-z]{3}$'))) {
-            evaluated = true
-            const result = z.string().safeParse(value[key])
-            if (!result.success) {
-              ctx.addIssue({
-                path: [...ctx.path, key],
-                code: 'custom',
-                message: `Invalid input: Key matching regex /${key}/ must match schema`,
-                params: {
-                  issues: result.error.issues,
-                },
-              })
-            }
-          }
-          if (!evaluated) {
-            const result = z.never().safeParse(value[key])
-            if (!result.success) {
-              ctx.addIssue({
-                path: [...ctx.path, key],
-                code: 'custom',
-                message: `Invalid input: must match catchall schema`,
-                params: {
-                  issues: result.error.issues,
-                },
-              })
-            }
-          }
-        }
-      })
-      .optional(),
-    pushTitle: z
-      .record(z.union([z.string(), z.never()]))
-      .superRefine((value, ctx) => {
-        for (const key in value) {
-          let evaluated = false
-          if (key.match(new RegExp('^[a-z]{3}$'))) {
-            evaluated = true
-            const result = z.string().safeParse(value[key])
-            if (!result.success) {
-              ctx.addIssue({
-                path: [...ctx.path, key],
-                code: 'custom',
-                message: `Invalid input: Key matching regex /${key}/ must match schema`,
-                params: {
-                  issues: result.error.issues,
-                },
-              })
-            }
-          }
-          if (!evaluated) {
-            const result = z.never().safeParse(value[key])
-            if (!result.success) {
-              ctx.addIssue({
-                path: [...ctx.path, key],
-                code: 'custom',
-                message: `Invalid input: must match catchall schema`,
-                params: {
-                  issues: result.error.issues,
-                },
-              })
-            }
-          }
-        }
-      })
-      .optional(),
-    pushTokens: z
-      .array(z.string())
-      .describe(
-        'List of push tokens to send the notification to. If not provided, the notification will be sent to all users who match the other criteria. If provided, the other filters will be ignored.'
-      )
-      .optional(),
-    verified: z
-      .array(z.string())
-      .describe(
-        "List of languages that have had their translation verified. These languages will NOT show the 'translated by AI' message in the app. English should never be included, as its translations are always verified."
-      ),
-  })
-  .strict()
-export type Notification = z.infer<typeof notification>