Merge pull request #189 from Telegram-Mini-Apps/feature/stable-sdk

Feature/stable sdk
Telegram-Mini-Apps · Nov 26, 2023 · f5e7dff · f5e7dff
2 parents eb0b193 + 60c23a8
commit f5e7dff
Show file tree

Hide file tree

Showing 755 changed files with 14,406 additions and 5,313 deletions.
diff --git a/.changeset/angry-peas-hide.md b/.changeset/angry-peas-hide.md
@@ -0,0 +1,6 @@
+---
+"@tma.js/sdk-react": major
+"@tma.js/sdk-solid": major
+---
+
+The first packages major releases. Their implementation was simplified as much as possible. Moreover, they look more similar now.
diff --git a/.changeset/gorgeous-students-smoke.md b/.changeset/gorgeous-students-smoke.md
@@ -0,0 +1,5 @@
+---
+"@tma.js/sdk": major
+---
+
+The first package major release. This time, it was fully reworked. All other @tma.js packages were moved to this package.
diff --git a/.changeset/quiet-trains-sin.md b/.changeset/quiet-trains-sin.md
@@ -0,0 +1,5 @@
+---
+"@tma.js/solid-router-integration": patch
+---
+
+The first package major version. It now references @tma.js/sdk for utilities.
diff --git a/.changeset/thick-wasps-leave.md b/.changeset/thick-wasps-leave.md
@@ -0,0 +1,5 @@
+---
+"@tma.js/init-data-node": major
+---
+
+The first package major release. Just setting a stable version.
diff --git a/.gitignore b/.gitignore
@@ -39,8 +39,8 @@ yarn-error.log*
 .idea
 .docusaurus
 
-# App for local development
-apps/.local
+# Apps for local development.
+apps-local
 
 apps/docs/.vitepress/cache
 apps/docs/.vitepress/dist
diff --git a/apps/docs/.vitepress/packages.ts b/apps/docs/.vitepress/packages.ts
@@ -4,47 +4,79 @@ function prefixed(value: string): string {
 
 export const packagesNavItem = {
   text: 'Packages',
-  link: prefixed('/typescript/tma-js-bridge'),
+  link: prefixed('/typescript/tma-js-sdk/about'),
 };
 
 export const packagesSidebar = {
   [prefixed('/')]: [
     {
       text: 'TypeScript',
       items: [
-        { text: '@tma.js/bridge', link: prefixed('/typescript/tma-js-bridge') },
-        {
-          text: '@tma.js/init-data',
-          collapsed: true,
-          items: [
-            { text: 'About', link: prefixed('/typescript/tma-js-init-data/about') },
-            { text: 'InitData', link: prefixed('/typescript/tma-js-init-data/init-data') },
-            { text: 'Chat', link: prefixed('/typescript/tma-js-init-data/chat') },
-            { text: 'User', link: prefixed('/typescript/tma-js-init-data/user') },
-          ],
-        },
-        {
-          text: '@tma.js/launch-params',
-          link: prefixed('/typescript/tma-js-launch-params'),
-        },
-        { text: '@tma.js/theme-params', link: prefixed('/typescript/tma-js-theme-params') },
-        { text: '@tma.js/navigation', link: prefixed('/typescript/tma-js-navigation') },
         {
           text: '@tma.js/sdk',
-          collapsed: true,
+          link: prefixed('/typescript/tma-js-sdk/about'),
           items: [
-            { text: 'About', link: prefixed('/typescript/tma-js-sdk/about') },
+            {
+              text: 'Initialization',
+              link: prefixed('/typescript/tma-js-sdk/init'),
+            },
+            {
+              text: 'Methods and events',
+              link: prefixed('/typescript/tma-js-sdk/methods-and-events'),
+            },
+            {
+              text: 'Launch parameters',
+              link: prefixed('/typescript/tma-js-sdk/launch-parameters'),
+            },
+            {
+              text: 'Theme parameters',
+              link: prefixed('/typescript/tma-js-sdk/theme-parameters'),
+            },
+            {
+              text: 'Init data',
+              collapsed: true,
+              items: [
+                {
+                  text: 'About',
+                  link: prefixed('/typescript/tma-js-sdk/init-data/about'),
+                },
+                {
+                  text: 'InitData',
+                  link: prefixed('/typescript/tma-js-sdk/init-data/init-data')
+                },
+                {
+                  text: 'Chat',
+                  link: prefixed('/typescript/tma-js-sdk/init-data/chat')
+                },
+                {
+                  text: 'User',
+                  link: prefixed('/typescript/tma-js-sdk/init-data/user')
+                },
+              ],
+            },
+            {
+              text: 'Navigation',
+              link: prefixed('/typescript/tma-js-sdk/navigation'),
+            },
             {
               text: 'Components',
               collapsed: true,
               items: [
+                {
+                  text: 'About components',
+                  link: prefixed('/typescript/tma-js-sdk/components/about'),
+                },
                 {
                   text: 'BackButton',
                   link: prefixed('/typescript/tma-js-sdk/components/back-button'),
                 },
                 {
                   text: 'ClosingBehavior',
-                  link: prefixed('/typescript/tma-js-sdk/components/closing-behaviour'),
+                  link: prefixed('/typescript/tma-js-sdk/components/closing-behavior'),
+                },
+                {
+                  text: 'CloudStorage',
+                  link: prefixed('/typescript/tma-js-sdk/components/cloud-storage'),
                 },
                 {
                   text: 'HapticFeedback',
@@ -54,10 +86,18 @@ export const packagesSidebar = {
                   text: 'InitData',
                   link: prefixed('/typescript/tma-js-sdk/components/init-data'),
                 },
+                {
+                  text: 'Invoice',
+                  link: prefixed('/typescript/tma-js-sdk/components/invoice'),
+                },
                 {
                   text: 'MainButton',
                   link: prefixed('/typescript/tma-js-sdk/components/main-button'),
                 },
+                {
+                  text: 'MiniApp',
+                  link: prefixed('/typescript/tma-js-sdk/components/mini-app'),
+                },
                 {
                   text: 'Popup',
                   link: prefixed('/typescript/tma-js-sdk/components/popup'),
@@ -71,13 +111,12 @@ export const packagesSidebar = {
                   link: prefixed('/typescript/tma-js-sdk/components/theme-params'),
                 },
                 {
-                  text: 'Viewport',
-                  link: prefixed('/typescript/tma-js-sdk/components/viewport'),
+                  text: 'Utils',
+                  link: prefixed('/typescript/tma-js-sdk/components/utils'),
                 },
-                // TODO: Rename?
                 {
-                  text: 'WebApp',
-                  link: prefixed('/typescript/tma-js-sdk/components/web-app'),
+                  text: 'Viewport',
+                  link: prefixed('/typescript/tma-js-sdk/components/viewport'),
                 },
               ],
             },
@@ -99,5 +138,27 @@ export const packagesSidebar = {
         { text: 'init-data-golang', link: prefixed('/golang/init-data-golang') },
       ],
     },
+    {
+      text: 'Deprecated',
+      items: [
+        { text: '@tma.js/bridge', link: prefixed('/typescript/tma-js-bridge') },
+        {
+          text: '@tma.js/init-data',
+          collapsed: true,
+          items: [
+            { text: 'About', link: prefixed('/typescript/tma-js-init-data/about') },
+            { text: 'InitData', link: prefixed('/typescript/tma-js-init-data/init-data') },
+            { text: 'Chat', link: prefixed('/typescript/tma-js-init-data/chat') },
+            { text: 'User', link: prefixed('/typescript/tma-js-init-data/user') },
+          ],
+        },
+        {
+          text: '@tma.js/launch-params',
+          link: prefixed('/typescript/tma-js-launch-params'),
+        },
+        { text: '@tma.js/theme-params', link: prefixed('/typescript/tma-js-theme-params') },
+        { text: '@tma.js/navigation', link: prefixed('/typescript/tma-js-navigation') },
+      ],
+    },
   ],
 };
diff --git a/apps/docs/packages/node/tma-js-init-data-node.md b/apps/docs/packages/node/tma-js-init-data-node.md
@@ -10,11 +10,6 @@ The package provides utilities to work with the initialization data of Telegram
 server side. To learn more about the initialization data and its usage, please refer to
 the [documentation](../../platform/launch-parameters/common-information.md).
 
-::: info
-This package extends the functionality of [@tma.js/init-data](../typescript/tma-js-init-data/about.md), including all
-its types and utilities. Therefore, there is no need to install both packages separately.
-:::
-
 ## Installation
 
 ::: code-group
@@ -31,14 +26,12 @@ yarn add @tma.js/init-data-node
 ```
 :::
 
-## Usage
-
-### Parsing
+## Parsing
 
-You can learn more about parsing utilities in [@tma.js/init-data](../typescript/tma-js-init-data/about.md#parsing)
+You can learn more about parsing utilities in [@tma.js/sdk](../typescript/tma-js-sdk/init-data/about#parsing)
 documentation.
 
-### Validation
+## Validation
 
 To validate the signature of the initialization data, the `validate` function is used. It expects
 the initialization data to be passed in raw format (search parameters) and throws an error in

diff --git a/apps/docs/packages/typescript/tma-js-bridge.md b/apps/docs/packages/typescript/tma-js-bridge.md
@@ -13,6 +13,11 @@ and saving their time.
 Developers can utilize this package to create their software development kit (SDK), as it offers the
 utmost level of control over cross-application communication.
 
+::: danger
+This project has been deprecated. All its functionality was moved to
+the [@tma.js/sdk](./tma-js-sdk/about.md) package.
+:::
+
 ## Installation
 
 ::: code-group

diff --git a/apps/docs/packages/typescript/tma-js-init-data/about.md b/apps/docs/packages/typescript/tma-js-init-data/about.md
@@ -8,7 +8,12 @@
 
 The package provides utilities to work with the initialization data of Telegram Mini Apps on the
 client side. To learn more about the initialization data and its usage, please refer to
-the [documentation](../../../platform/launch-parameters/common-information.md).
+the [documentation](../../../platform/launch-parameters/init-data.md).
+
+::: danger
+This project has been deprecated. All its functionality was moved to
+the [@tma.js/sdk](../tma-js-sdk/about.md) package.
+:::
 
 ## Installation
 

diff --git a/apps/docs/packages/typescript/tma-js-launch-params.md b/apps/docs/packages/typescript/tma-js-launch-params.md
@@ -9,6 +9,11 @@
 Provides utilities to work with Telegram Mini
 Apps [launch parameters](../../platform/launch-parameters/common-information.md).
 
+::: danger
+This project has been deprecated. All its functionality was moved to
+the [@tma.js/sdk](./tma-js-sdk/about.md) package.
+:::
+
 ## Installation
 
 ::: code-group

diff --git a/apps/docs/packages/typescript/tma-js-navigation.md b/apps/docs/packages/typescript/tma-js-navigation.md
@@ -12,6 +12,11 @@ outline: [2, 3]
 
 Package for manipulating Mini App navigation on the Telegram Mini Apps platform.
 
+::: danger
+This project has been deprecated. All its functionality was moved to
+the [@tma.js/sdk](./tma-js-sdk/about.md) package.
+:::
+
 ## Installation
 
 ::: code-group