2022-07-13 19:02:55 +12:00
< ? php
2022-07-14 14:04:31 +12:00
2022-11-14 23:01:41 +13:00
namespace Appwrite\Platform\Tasks ;
2022-07-13 19:02:55 +12:00
use Utopia\Platform\Action ;
2022-10-28 10:06:09 +13:00
use Appwrite\SDK\Language\Android ;
2022-07-13 19:02:55 +12:00
use Appwrite\SDK\Language\CLI ;
use Appwrite\SDK\Language\Dart ;
use Appwrite\SDK\Language\Deno ;
use Appwrite\SDK\Language\DotNet ;
use Appwrite\SDK\Language\Flutter ;
use Appwrite\SDK\Language\Go ;
2022-10-28 10:06:09 +13:00
use Appwrite\SDK\Language\GraphQL ;
2022-07-13 19:02:55 +12:00
use Appwrite\SDK\Language\Kotlin ;
2022-10-28 10:06:09 +13:00
use Appwrite\SDK\Language\Node ;
use Appwrite\SDK\Language\PHP ;
use Appwrite\SDK\Language\Python ;
use Appwrite\SDK\Language\REST ;
use Appwrite\SDK\Language\Ruby ;
2022-07-13 19:02:55 +12:00
use Appwrite\SDK\Language\Swift ;
2022-12-19 19:05:35 +13:00
use Appwrite\SDK\Language\Apple ;
2022-10-28 10:06:09 +13:00
use Appwrite\SDK\Language\Web ;
use Appwrite\SDK\SDK ;
use Appwrite\Spec\Swagger2 ;
use Utopia\CLI\Console ;
use Utopia\Config\Config ;
2022-07-13 19:02:55 +12:00
2022-07-14 14:04:31 +12:00
class SDKs extends Action
{
2022-08-02 13:58:36 +12:00
public static function getName () : string
{
return 'sdks' ;
}
2022-07-14 14:04:31 +12:00
2022-07-13 19:02:55 +12:00
public function __construct ()
{
$this
2022-08-02 13:58:36 +12:00
-> desc ( 'Generate Appwrite SDKs' )
2022-11-14 23:36:21 +13:00
-> callback ( fn () => $this -> action ());
2022-07-13 19:02:55 +12:00
}
public function action () : void
{
$platforms = Config :: getParam ( 'platforms' );
2023-01-14 01:32:47 +13:00
$selectedPlatform = Console :: confirm ( 'Choose Platform ("' . APP_PLATFORM_CLIENT . '", "' . APP_PLATFORM_SERVER . '", "' . APP_PLATFORM_CONSOLE . '" or "*" for all):' );
2023-01-14 01:29:22 +13:00
$selectedSDK = \strtolower ( Console :: confirm ( 'Choose SDK ("*" for all):' ));
2022-07-13 19:02:55 +12:00
$version = Console :: confirm ( 'Choose an Appwrite version' );
$git = ( Console :: confirm ( 'Should we use git push? (yes/no)' ) == 'yes' );
$production = ( $git ) ? ( Console :: confirm ( 'Type "Appwrite" to push code to production git repos' ) == 'Appwrite' ) : false ;
$message = ( $git ) ? Console :: confirm ( 'Please enter your commit message:' ) : '' ;
2024-02-06 01:40:51 +13:00
if ( ! in_array ( $version , [ '0.6.x' , '0.7.x' , '0.8.x' , '0.9.x' , '0.10.x' , '0.11.x' , '0.12.x' , '0.13.x' , '0.14.x' , '0.15.x' , '1.0.x' , '1.1.x' , '1.2.x' , '1.3.x' , '1.4.x' , '1.5.x' , 'latest' ])) {
2022-07-13 19:02:55 +12:00
throw new Exception ( 'Unknown version given' );
}
foreach ( $platforms as $key => $platform ) {
2023-01-14 01:29:22 +13:00
if ( $selectedPlatform !== $key && $selectedPlatform !== '*' ) {
continue ;
}
foreach ( $platform [ 'sdks' ] as $language ) {
if ( $selectedSDK !== $language [ 'key' ] && $selectedSDK !== '*' ) {
2022-07-13 19:02:55 +12:00
continue ;
}
if ( ! $language [ 'enabled' ]) {
Console :: warning ( $language [ 'name' ] . ' for ' . $platform [ 'name' ] . ' is disabled' );
continue ;
}
Console :: info ( 'Fetching API Spec for ' . $language [ 'name' ] . ' for ' . $platform [ 'name' ] . ' (version: ' . $version . ')' );
2023-02-09 05:34:22 +13:00
$spec = file_get_contents ( __DIR__ . '/../../../../app/config/specs/swagger2-' . $version . '-' . $language [ 'family' ] . '.json' );
2022-07-13 19:02:55 +12:00
2024-03-03 15:34:36 +13:00
$cover = 'https://github.com/appwrite/appwrite/raw/main/public/images/github.png' ;
2023-02-09 05:34:22 +13:00
$result = \realpath ( __DIR__ . '/../../../../app' ) . '/sdks/' . $key . '-' . $language [ 'key' ];
$resultExamples = \realpath ( __DIR__ . '/../../../..' ) . '/docs/examples/' . $version . '/' . $key . '-' . $language [ 'key' ];
$target = \realpath ( __DIR__ . '/../../../../app' ) . '/sdks/git/' . $language [ 'key' ] . '/' ;
$readme = \realpath ( __DIR__ . '/../../../../docs/sdks/' . $language [ 'key' ] . '/README.md' );
2022-07-13 19:02:55 +12:00
$readme = ( $readme ) ? \file_get_contents ( $readme ) : '' ;
2023-02-09 05:34:22 +13:00
$gettingStarted = \realpath ( __DIR__ . '/../../../../docs/sdks/' . $language [ 'key' ] . '/GETTING_STARTED.md' );
2022-07-13 19:02:55 +12:00
$gettingStarted = ( $gettingStarted ) ? \file_get_contents ( $gettingStarted ) : '' ;
2023-02-09 05:34:22 +13:00
$examples = \realpath ( __DIR__ . '/../../../../docs/sdks/' . $language [ 'key' ] . '/EXAMPLES.md' );
2022-07-13 19:02:55 +12:00
$examples = ( $examples ) ? \file_get_contents ( $examples ) : '' ;
2023-02-09 05:34:22 +13:00
$changelog = \realpath ( __DIR__ . '/../../../../docs/sdks/' . $language [ 'key' ] . '/CHANGELOG.md' );
2022-07-13 19:02:55 +12:00
$changelog = ( $changelog ) ? \file_get_contents ( $changelog ) : '# Change Log' ;
$warning = '**This SDK is compatible with Appwrite server version ' . $version . '. For older versions, please check [previous releases](' . $language [ 'url' ] . '/releases).**' ;
$license = 'BSD-3-Clause' ;
$licenseContent = 'Copyright (c) ' . date ( 'Y' ) . ' Appwrite ( https :// appwrite . io ) and individual contributors .
All rights reserved .
Redistribution and use in source and binary forms , with or without modification , are permitted provided that the following conditions are met :
1. Redistributions of source code must retain the above copyright notice , this list of conditions and the following disclaimer .
2. Redistributions in binary form must reproduce the above copyright notice , this list of conditions and the following disclaimer in the documentation and / or other materials provided with the distribution .
2022-10-13 05:53:46 +13:00
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission .
2022-07-13 19:02:55 +12:00
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS " AS IS " AND ANY EXPRESS OR IMPLIED WARRANTIES , INCLUDING , BUT NOT LIMITED TO , THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED . IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT , INDIRECT , INCIDENTAL , SPECIAL , EXEMPLARY , OR CONSEQUENTIAL DAMAGES ( INCLUDING , BUT NOT LIMITED TO , PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES ; LOSS OF USE , DATA , OR PROFITS ; OR BUSINESS INTERRUPTION ) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY , WHETHER IN CONTRACT , STRICT LIABILITY , OR TORT ( INCLUDING NEGLIGENCE OR OTHERWISE ) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE , EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE . ' ;
switch ( $language [ 'key' ]) {
case 'web' :
$config = new Web ();
2023-02-28 21:35:40 +13:00
if ( $platform [ 'key' ] === APP_PLATFORM_CONSOLE ) {
$config -> setNPMPackage ( '@appwrite.io/console' );
$config -> setBowerPackage ( '@appwrite.io/console' );
} else {
$config -> setNPMPackage ( 'appwrite' );
$config -> setBowerPackage ( 'appwrite' );
}
2022-07-13 19:02:55 +12:00
break ;
case 'cli' :
$config = new CLI ();
$config -> setNPMPackage ( 'appwrite-cli' );
$config -> setExecutableName ( 'appwrite' );
$config -> setLogo ( json_encode ( "
_ _ _ ___ __ _____
/ _\ _ __ _ ____ ___ __ ( _ ) | _ ___ / __\ / / \_ \
//_\\\| '_ \| '_ \ \ /\ / / '__| | __/ _ \ / / / / / /\/
/ _ \ | _ ) | | _ ) \ V V /| | | | || __ / / / ___ / / ___ / \ / / _
\_ / \_ / . __ /| . __ / \_ / \_ / | _ | | _ | \__\___ | \____ / \____ / \____ /
| _ | | _ |
" ));
$config -> setLogoUnescaped ( "
_ _ _ ___ __ _____
/ _\ _ __ _ ____ ___ __ ( _ ) | _ ___ / __\ / / \_ \
//_\\\| '_ \| '_ \ \ /\ / / '__| | __/ _ \ / / / / / /\/
/ _ \ | _ ) | | _ ) \ V V /| | | | || __ / / / ___ / / ___ / \ / / _
\_ / \_ / . __ /| . __ / \_ / \_ / | _ | | _ | \__\___ | \____ / \____ / \____ /
| _ | | _ | " );
break ;
case 'php' :
$config = new PHP ();
$config -> setComposerVendor ( 'appwrite' );
$config -> setComposerPackage ( 'appwrite' );
break ;
case 'nodejs' :
$config = new Node ();
$config -> setNPMPackage ( 'node-appwrite' );
$config -> setBowerPackage ( 'appwrite' );
$warning = $warning . " \n \n > This is the Node.js SDK for integrating with Appwrite from your Node.js server-side code.
If you ' re looking to integrate from the browser , you should check [ appwrite / sdk - for - web ]( https :// github . com / appwrite / sdk - for - web ) " ;
break ;
case 'deno' :
$config = new Deno ();
break ;
case 'python' :
$config = new Python ();
$config -> setPipPackage ( 'appwrite' );
$license = 'BSD License' ; // license edited due to classifiers in pypi
break ;
case 'ruby' :
$config = new Ruby ();
$config -> setGemPackage ( 'appwrite' );
break ;
case 'flutter' :
$config = new Flutter ();
$config -> setPackageName ( 'appwrite' );
break ;
case 'flutter-dev' :
$config = new Flutter ();
$config -> setPackageName ( 'appwrite_dev' );
break ;
case 'dart' :
$config = new Dart ();
$config -> setPackageName ( 'dart_appwrite' );
$warning = $warning . " \n \n > This is the Dart SDK for integrating with Appwrite from your Dart server-side code. If you're looking for the Flutter SDK you should check [appwrite/sdk-for-flutter](https://github.com/appwrite/sdk-for-flutter) " ;
break ;
case 'go' :
$config = new Go ();
break ;
case 'swift' :
$config = new Swift ();
$warning = $warning . " \n \n > This is the Swift SDK for integrating with Appwrite from your Swift server-side code. If you're looking for the Apple SDK you should check [appwrite/sdk-for-apple](https://github.com/appwrite/sdk-for-apple) " ;
break ;
case 'apple' :
2022-12-19 19:05:35 +13:00
$config = new Apple ();
2022-07-13 19:02:55 +12:00
break ;
case 'dotnet' :
$cover = '' ;
$config = new DotNet ();
break ;
case 'android' :
$config = new Android ();
break ;
case 'kotlin' :
$config = new Kotlin ();
$warning = $warning . " \n \n > This is the Kotlin SDK for integrating with Appwrite from your Kotlin server-side code. If you're looking for the Android SDK you should check [appwrite/sdk-for-android](https://github.com/appwrite/sdk-for-android) " ;
break ;
2022-10-20 16:21:16 +13:00
case 'graphql' :
$config = new GraphQL ();
break ;
2022-10-26 16:19:30 +13:00
case 'rest' :
$config = new REST ();
break ;
2022-07-13 19:02:55 +12:00
default :
throw new Exception ( 'Language "' . $language [ 'key' ] . '" not supported' );
}
Console :: info ( " Generating { $language [ 'name' ] } SDK... " );
$sdk = new SDK ( $config , new Swagger2 ( $spec ));
$sdk
-> setName ( $language [ 'name' ])
-> setNamespace ( 'io appwrite' )
-> setDescription ( " Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the { $language [ 'name' ] } SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs) " )
-> setShortDescription ( 'Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API' )
-> setLicense ( $license )
-> setLicenseContent ( $licenseContent )
-> setVersion ( $language [ 'version' ])
2022-08-11 01:00:57 +12:00
-> setPlatform ( $key )
2022-07-13 19:02:55 +12:00
-> setGitURL ( $language [ 'url' ])
-> setGitRepo ( $language [ 'gitUrl' ])
-> setGitRepoName ( $language [ 'gitRepoName' ])
-> setGitUserName ( $language [ 'gitUserName' ])
-> setLogo ( $cover )
-> setURL ( 'https://appwrite.io' )
-> setShareText ( 'Appwrite is a backend as a service for building web or mobile apps' )
-> setShareURL ( 'http://appwrite.io' )
-> setShareTags ( 'JS,javascript,reactjs,angular,ios,android,serverless' )
-> setShareVia ( 'appwrite' )
-> setWarning ( $warning )
-> setReadme ( $readme )
-> setGettingStarted ( $gettingStarted )
-> setChangelog ( $changelog )
-> setExamples ( $examples )
-> setTwitter ( APP_SOCIAL_TWITTER_HANDLE )
-> setDiscord ( APP_SOCIAL_DISCORD_CHANNEL , APP_SOCIAL_DISCORD )
-> setDefaultHeaders ([
2024-02-19 16:54:53 +13:00
'X-Appwrite-Response-Format' => '1.5.0' ,
2022-07-13 19:02:55 +12:00
]);
2023-11-16 21:50:39 +13:00
// Make sure we have a clean slate.
// Otherwise, all files in this dir will be pushed,
// regardless of whether they were just generated or not.
\exec ( 'rm -rf ' . $result );
2022-07-13 19:02:55 +12:00
try {
$sdk -> generate ( $result );
2024-02-08 14:17:54 +13:00
} catch ( \Throwable $exception ) {
2022-07-13 19:02:55 +12:00
Console :: error ( $exception -> getMessage ());
}
$gitUrl = $language [ 'gitUrl' ];
$gitBranch = $language [ 'gitBranch' ];
if ( ! $production ) {
$gitUrl = 'git@github.com:aw-tests/' . $language [ 'gitRepoName' ] . '.git' ;
}
if ( $git && ! empty ( $gitUrl )) {
2023-11-01 21:02:42 +13:00
\exec ( 'rm -rf ' . $target . ' && \
mkdir - p ' . $target . ' && \
cd ' . $target . ' && \
git init -- initial - branch = ' . $gitBranch . ' && \
git remote add origin ' . $gitUrl . ' && \
git fetch origin ' . $gitBranch . ' && \
git pull origin ' . $gitBranch . ' && \
rm - rf ' . $target . ' /* && \
2024-02-23 18:32:15 +13:00
cp - r ' . $result . ' /. ' . $target . ' / && \
2023-11-01 21:02:42 +13:00
git add . && \
git commit - m " ' . $message . ' " && \
git push - u origin ' . $gitBranch . '
' );
2022-07-13 19:02:55 +12:00
Console :: success ( " Pushed { $language [ 'name' ] } SDK to { $gitUrl } " );
\exec ( 'rm -rf ' . $target );
Console :: success ( " Remove temp directory ' { $target } ' for { $language [ 'name' ] } SDK " );
}
$docDirectories = $language [ 'docDirectories' ] ? ? [ '' ];
if ( $version === 'latest' ) {
continue ;
}
foreach ( $docDirectories as $languageTitle => $path ) {
$languagePath = strtolower ( $languageTitle !== 0 ? '/' . $languageTitle : '' );
\exec (
'mkdir -p ' . $resultExamples . $languagePath . ' && \
cp - r ' . $result . ' / docs / examples ' . $languagePath . ' ' . $resultExamples
);
Console :: success ( " Copied code examples for { $language [ 'name' ] } SDK to: { $resultExamples } " );
}
}
}
Console :: exit ();
}
2022-07-14 14:04:31 +12:00
}