@tma.js/sdk 0.11.3

package/src/supports.ts

@@ -0,0 +1,44 @@
+import type { Version } from '@tma.js/utils';
+import {
+  supports,
+  type MethodName,
+  type HasCheckSupportMethodName,
+  type HasCheckSupportMethodParam,
+} from '@tma.js/bridge';
+
+export type SupportsFunc<M extends string> = (method: M) => boolean;
+
+type HasCheckSupportMethodTuple = {
+  [M in HasCheckSupportMethodName]: [M, HasCheckSupportMethodParam<M>]
+}[HasCheckSupportMethodName];
+
+/**
+ * Returns function, which accepts predefined method name and checks if it is supported
+ * via passed schema and version.
+ * @param schema - object which contains methods names and TWA method as a dependency.
+ * @param version - platform version.
+ */
+export function createSupportsFunc<M extends string>(
+  version: Version,
+  schema: Record<M, MethodName>,
+): SupportsFunc<M> {
+  return (method) => supports(schema[method], version);
+}
+
+/**
+ * Returns function, which accepts predefined method name and checks if it is supported
+ * via passed schema and version.
+ * @param schema - object which contains methods names and TWA methods with specified parameter
+ * as a dependency.
+ * @param version - platform version.
+ */
+export function createSupportsParamFunc<P extends string>(
+  version: Version,
+  schema: Record<P, HasCheckSupportMethodTuple>,
+): SupportsFunc<P> {
+  return (method) => {
+    const [tmaMethod, param] = schema[method];
+
+    return supports(tmaMethod, param, version);
+  };
+}

package/src/theme-params.ts

@@ -0,0 +1,34 @@
+import { json, rgb } from '@tma.js/parsing';
+
+import type { RGB } from '@tma.js/colors';
+
+/**
+ * Application theme parameters. Defines palette used by the Telegram application.
+ */
+export interface ThemeParamsType {
+  backgroundColor?: RGB;
+  buttonColor?: RGB;
+  buttonTextColor?: RGB;
+  hintColor?: RGB;
+  linkColor?: RGB;
+  secondaryBackgroundColor?: RGB;
+  textColor?: RGB;
+}
+
+const themeParamsParser = json<ThemeParamsType>({
+  backgroundColor: { type: rgb().optional(), from: 'bg_color' },
+  buttonColor: { type: rgb().optional(), from: 'button_color' },
+  buttonTextColor: { type: rgb().optional(), from: 'button_text_color' },
+  hintColor: { type: rgb().optional(), from: 'hint_color' },
+  linkColor: { type: rgb().optional(), from: 'link_color' },
+  textColor: { type: rgb().optional(), from: 'text_color' },
+  secondaryBackgroundColor: { type: rgb().optional(), from: 'secondary_bg_color' },
+});
+
+/**
+ * Parses incoming value as theme parameters.
+ * @param value - value to parse.
+ */
+export function parseThemeParams(value: unknown): ThemeParamsType {
+  return themeParamsParser.parse(value);
+}

package/src/types.ts

@@ -0,0 +1,28 @@
+import type { PostEvent as BridgePostEvent } from '@tma.js/bridge';
+
+export type PostEvent = BridgePostEvent;
+
+/**
+ * Color scheme.
+ */
+export type ColorScheme = 'dark' | 'light';
+
+/**
+ * Native Telegram application identifier.
+ */
+export type Platform =
+  | 'android'
+  | 'android_x'
+  | 'ios'
+  | 'macos'
+  | 'tdesktop'
+  | 'web'
+  | 'weba'
+  | 'unigram'
+  | 'unknown'
+  | string;
+
+/**
+ * Function which generates unique request identifiers.
+ */
+export type CreateRequestIdFunc = () => string;

package/src/url.ts

@@ -0,0 +1,24 @@
+/**
+ * Converts passed URL to its full form.
+ * @param url - URL to format.
+ * @throws {Error} URL protocol is not supported by OS, or link has not allowed
+ * protocol.
+ */
+export function formatURL(url: string): string {
+  // TODO: Maybe, there is a bit easier way? window.open will accept
+  //  unformatted URL too, probably.
+
+  // We do create new anchor element and assign its href to passed URL. This
+  // will format link, so it could be used in `window.open`.
+  const anchor = document.createElement('a');
+  anchor.href = url;
+
+  // Check if protocol is correct.
+  if (anchor.protocol !== 'http:' && anchor.protocol !== 'https:') {
+    throw Error(
+      'URL protocol is not supported by OS, or link has not allowed '
+      + `protocol: ${anchor.protocol}`,
+    );
+  }
+  return anchor.href;
+}