-
Notifications
You must be signed in to change notification settings - Fork 160
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #794 from appwrite/feat-react-native-sdk
React native SDK
- Loading branch information
Showing
22 changed files
with
1,400 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,247 @@ | ||
| <?php | ||
|
|
||
| namespace Appwrite\SDK\Language; | ||
|
|
||
| use Twig\TwigFilter; | ||
|
|
||
| class ReactNative extends Web | ||
| { | ||
| /** | ||
| * @return string | ||
| */ | ||
| public function getName(): string | ||
| { | ||
| return 'ReactNative'; | ||
| } | ||
|
|
||
| /** | ||
| * @return array | ||
| */ | ||
| public function getFiles(): array | ||
| { | ||
| return [ | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'src/index.ts', | ||
| 'template' => 'react-native/src/index.ts.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'src/client.ts', | ||
| 'template' => 'react-native/src/client.ts.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'src/service.ts', | ||
| 'template' => 'react-native/src/service.ts.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'service', | ||
| 'destination' => 'src/services/{{service.name | caseDash}}.ts', | ||
| 'template' => 'react-native/src/services/template.ts.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'src/models.ts', | ||
| 'template' => 'react-native/src/models.ts.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'src/permission.ts', | ||
| 'template' => 'react-native/src/permission.ts.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'src/role.ts', | ||
| 'template' => 'react-native/src/role.ts.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'src/id.ts', | ||
| 'template' => 'react-native/src/id.ts.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'src/query.ts', | ||
| 'template' => 'react-native/src/query.ts.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'README.md', | ||
| 'template' => 'react-native/README.md.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'CHANGELOG.md', | ||
| 'template' => 'react-native/CHANGELOG.md.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'LICENSE', | ||
| 'template' => 'react-native/LICENSE.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'package.json', | ||
| 'template' => 'react-native/package.json.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'method', | ||
| 'destination' => 'docs/examples/{{service.name | caseLower}}/{{method.name | caseDash}}.md', | ||
| 'template' => 'react-native/docs/example.md.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'tsconfig.json', | ||
| 'template' => '/react-native/tsconfig.json.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'rollup.config.js', | ||
| 'template' => '/react-native/rollup.config.js.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'dist/cjs/package.json', | ||
| 'template' => '/react-native/dist/cjs/package.json.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => 'dist/esm/package.json', | ||
| 'template' => '/react-native/dist/esm/package.json.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'default', | ||
| 'destination' => '.github/workflows/publish.yml', | ||
| 'template' => 'react-native/.github/workflows/publish.yml.twig', | ||
| ], | ||
| [ | ||
| 'scope' => 'enum', | ||
| 'destination' => 'src/enums/{{ enum.name | caseDash }}.ts', | ||
| 'template' => 'react-native/src/enums/enum.ts.twig', | ||
| ], | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * @param array $parameter | ||
| * @param array $nestedTypes | ||
| * @return string | ||
| */ | ||
| public function getTypeName(array $parameter, array $spec = []): string | ||
| { | ||
| if (isset($parameter['enumName'])) { | ||
| return \ucfirst($parameter['enumName']); | ||
| } | ||
| if (!empty($parameter['enumValues'])) { | ||
| return \ucfirst($parameter['name']); | ||
| } | ||
| switch ($parameter['type']) { | ||
| case self::TYPE_INTEGER: | ||
| case self::TYPE_NUMBER: | ||
| return 'number'; | ||
| case self::TYPE_ARRAY: | ||
| if (!empty(($parameter['array'] ?? [])['type']) && !\is_array($parameter['array']['type'])) { | ||
| return $this->getTypeName($parameter['array']) . '[]'; | ||
| } | ||
| return 'string[]'; | ||
| case self::TYPE_FILE: | ||
| return 'any'; | ||
| } | ||
|
|
||
| return $parameter['type']; | ||
| } | ||
|
|
||
| /** | ||
| * @param array $param | ||
| * @return string | ||
| */ | ||
| public function getParamExample(array $param): string | ||
| { | ||
| $type = $param['type'] ?? ''; | ||
| $example = $param['example'] ?? ''; | ||
|
|
||
| $output = ''; | ||
|
|
||
| if (empty($example) && $example !== 0 && $example !== false) { | ||
| switch ($type) { | ||
| case self::TYPE_NUMBER: | ||
| case self::TYPE_INTEGER: | ||
| case self::TYPE_BOOLEAN: | ||
| $output .= 'null'; | ||
| break; | ||
| case self::TYPE_STRING: | ||
| $output .= "''"; | ||
| break; | ||
| case self::TYPE_ARRAY: | ||
| $output .= '[]'; | ||
| break; | ||
| case self::TYPE_OBJECT: | ||
| $output .= '{}'; | ||
| break; | ||
| case self::TYPE_FILE: | ||
| $output .= "await pickSingle()"; | ||
| break; | ||
| } | ||
| } else { | ||
| switch ($type) { | ||
| case self::TYPE_NUMBER: | ||
| case self::TYPE_INTEGER: | ||
| case self::TYPE_ARRAY: | ||
| case self::TYPE_OBJECT: | ||
| $output .= $example; | ||
| break; | ||
| case self::TYPE_BOOLEAN: | ||
| $output .= ($example) ? 'true' : 'false'; | ||
| break; | ||
| case self::TYPE_STRING: | ||
| $output .= "'{$example}'"; | ||
| break; | ||
| case self::TYPE_FILE: | ||
| $output .= "await pickSingle()"; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| return $output; | ||
| } | ||
|
|
||
| public function getReturn(array $method, array $spec): string | ||
| { | ||
| if ($method['type'] === 'webAuth') { | ||
| return 'void | URL'; | ||
| } elseif ($method['type'] === 'location') { | ||
| return 'URL'; | ||
| } | ||
|
|
||
| if (array_key_exists('responseModel', $method) && !empty($method['responseModel']) && $method['responseModel'] !== 'any') { | ||
| $ret = 'Promise<'; | ||
|
|
||
| if ( | ||
| array_key_exists($method['responseModel'], $spec['definitions']) && | ||
| array_key_exists('additionalProperties', $spec['definitions'][$method['responseModel']]) && | ||
| !$spec['definitions'][$method['responseModel']]['additionalProperties'] | ||
| ) { | ||
| $ret .= 'Models.'; | ||
| } | ||
|
|
||
| $ret .= $this->toPascalCase($method['responseModel']); | ||
|
|
||
| $models = []; | ||
|
|
||
| $this->populateGenerics($method['responseModel'], $spec, $models); | ||
|
|
||
| $models = array_unique($models); | ||
| $models = array_filter($models, fn ($model) => $model != $this->toPascalCase($method['responseModel'])); | ||
|
|
||
| if (!empty($models)) { | ||
| $ret .= '<' . implode(', ', $models) . '>'; | ||
| } | ||
|
|
||
| $ret .= '>'; | ||
|
|
||
| return $ret; | ||
| } | ||
| return 'Promise<{}>'; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| name: Publish to NPM | ||
|
|
||
| on: | ||
| release: | ||
| types: [published] | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| publish: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| # Setup Node.js environment | ||
| - name: Use Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: '20.x' | ||
| registry-url: 'https://registry.npmjs.org' | ||
|
|
||
| # Determine release tag based on the tag name | ||
| - name: Determine release tag | ||
| id: release_tag | ||
| run: | | ||
| if [[ "${{ '{{' }} github.ref {{ '}}' }}" == *"-rc"* ]]; then | ||
| echo "tag=next" >> "$GITHUB_OUTPUT" | ||
| else | ||
| echo "tag=latest" >> "$GITHUB_OUTPUT" | ||
| fi | ||
|
|
||
| # Install dependencies (if any) and build your project (if necessary) | ||
| - name: Install dependencies and build | ||
| run: | | ||
| npm install | ||
| npm run build | ||
|
|
||
| # Publish to NPM with the appropriate tag | ||
| - name: Publish | ||
| run: npm publish --tag ${{ '{{' }} steps.release_tag.outputs.tag {{ '}}' }} | ||
| env: | ||
| NODE_AUTH_TOKEN: ${{ '{{' }} secrets.NPM_TOKEN {{ '}}' }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {{sdk.changelog}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {{sdk.licenseContent | raw}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # {{ spec.title }} {{sdk.name}} SDK | ||
|
|
||
|  | ||
|  | ||
| [](https://travis-ci.com/appwrite/sdk-generator) | ||
| {% if sdk.twitterHandle %} | ||
| [](https://twitter.com/{{ sdk.twitterHandle }}) | ||
| {% endif %} | ||
| {% if sdk.discordChannel %} | ||
| []({{ sdk.discordUrl }}) | ||
| {% endif %} | ||
| {% if sdk.warning %} | ||
|
|
||
| {{ sdk.warning|raw }} | ||
| {% endif %} | ||
|
|
||
| {{ sdk.description }} | ||
|
|
||
| {% if sdk.logo %} | ||
|  | ||
| {% endif %} | ||
|
|
||
| ## Installation | ||
|
|
||
| To install | ||
|
|
||
| ```bash | ||
| npx expo install react-native-appwrite react-native-url-polyfill | ||
| ``` | ||
|
|
||
| {% if sdk.gettingStarted %} | ||
|
|
||
| {{ sdk.gettingStarted|raw }} | ||
| {% endif %} | ||
|
|
||
| ## Contribution | ||
|
|
||
| This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request. | ||
|
|
||
| ## License | ||
|
|
||
| Please see the [{{spec.licenseName}} license]({{spec.licenseURL}}) file for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "type": "commonjs" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "type": "module" | ||
| } |
Oops, something went wrong.