@accelbyte/codegen 1.0.0-alpha.1 → 1.0.0-alpha.12

package/LICENSE

@@ -0,0 +1,19 @@
+AccelByte Development Code License
+
+This development code license agreement (“Agreement”) is between you and AccelByte, Inc. ("AccelByte"), and governs your use of the library, sample code or other software that is accompanied by this license (the "Licensed Software"). By using the Licensed Software, you agree to be bound by the terms of this Agreement. If you do not agree to the terms of this Agreement, do not use the Licensed Software.
+
+1. License Grant. AccelByte hereby grants you a revocable, non-exclusive, non-sublicensable, non-transferrable license to use the Licensed Software, solely to develop your own games that are designed to operate on the AccelByte platform (available under a separate agreement), and solely as needed to enable that operation.
+
+2. Restrictions. Except as expressly permitted in this Agreement, you may not: (a) copy, modify, or create derivative works of the Licensed Software; (b) distribute, sublicense, lease, rent, loan, or otherwise transfer the Licensed Software or any rights granted under this Agreement; (c) reverse engineer, decompile, or disassemble the Licensed Software; or (d) make the functionality of the Licensed Software available to any third party.
+
+3. Termination. This Agreement will remain in effect until terminated by you or AccelByte. AccelByte may terminate this Agreement at any time for any reason. Upon termination of this Agreement, you must cease all use of the Licensed Software and destroy all copies of the Licensed Software in your possession or control.
+
+4. Proprietary Rights. The Licensed Software is owned and copyrighted by AccelByte. Your license to use the Licensed Software does not grant you any right, title, or interest in or to the Licensed Software, except for the limited rights expressly granted in this Agreement.
+
+5. Disclaimer of Warranties. THE LICENSED SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, ACCELBYTE DISCLAIMS ALL WARRANTIES, WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
+
+6. Limitation of Liability. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL ACCELBYTE BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR ANY OTHER DAMAGES OF ANY KIND, ARISING FROM OR RELATED TO THIS AGREEMENT OR THE SDK, WHETHER IN CONTRACT, TORT, OR OTHERWISE, EVEN IF ACCELBYTE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. Governing Law. This Agreement will be governed by and construed in accordance with the laws of the state of Washington in the United States of America, without regard to its conflict of law provisions.
+
+8. Contact Information. If you have any questions about this Agreement, please contact AccelByte at: hello@accelbyte.io. Last updated: October 26, 2022

package/PATCHING.md

@@ -0,0 +1,137 @@
+# Code Generator Patching
+
+This document outlines the steps required when patching an Open API specs.
+
+## JSON Patch
+
+Inside the directory `packages/od-codegen/src/swaggers`, there are also JSON Patch that will patch the Swagger document. The patches will adjust the endpoints so that it will produce the proper functions to match the actual backend service. 
+We use https://github.com/Starcounter-Jack/JSON-Patch library that follow https://jsonpatch.com/ format
+
+### Operations
+
+#### Add
+```
+{ "op": "add", "path": "/biscuits/1", "value": { "name": "Ginger Nut" } }
+```
+Adds a value to an object or inserts it into an array. In the case of an array, the value is inserted before the given index. The - character can be used instead of an index to insert at the end of an array.
+
+#### Remove
+```
+{ "op": "remove", "path": "/biscuits" }
+```
+Removes a value from an object or array.
+```
+{ "op": "remove", "path": "/biscuits/0" }
+```
+Removes the first element of the array at biscuits (or just removes the “0” key if biscuits is an object)
+
+#### Replace
+```
+{ "op": "replace", "path": "/biscuits/0/name", "value": "Chocolate Digestive" }
+```
+Replaces a value. Equivalent to a “remove” followed by an “add”.
+
+#### Copy
+```
+{ "op": "copy", "from": "/biscuits/0", "path": "/best_biscuit" }
+```
+Copies a value from one location to another within the JSON document. Both from and path are JSON Pointers.
+
+#### Move
+```
+{ "op": "move", "from": "/biscuits", "path": "/cookies" }
+```
+Moves a value from one location to the other. Both from and path are JSON Pointers.
+
+#### Test
+```
+{ "op": "test", "path": "/best_biscuit/name", "value": "Choco Leibniz" }
+```
+Tests that the specified value is set in the document. If the test fails, then the patch as a whole should not apply.
+
+### Example
+For example, take a look at the this object
+```oauthmodel.TokenResponseV3": {
+   "required": [
+    "access_token",
+    "refresh_token",
+    "expires_in",
+    "token_type",
+    "roles",
+    "permissions",
+    "bans",
+    "user_id",
+    "display_name",
+    "namespace",
+    "namespace_roles",
+    "refresh_expires_in",
+    "scope",
+    "xuid"
+   ],
+   // ...
+}
+```
+
+This definition says that `TokenResponseV3` will always give out `xuid`. Yet at the moment, that property shouldn't always appear in the current IAM and the Swagger JSON is mistakenly written that way. If we kept the `xuid` property there, the response validation in the Web SDK will throw error and say the response missed the `xuid` property. Therefore, the JSON Patches are created, and it looks like this
+
+```
+  {
+    "op": "remove",
+    "path": "/definitions/oauthmodel.TokenResponseV3/required/13"
+  }
+  ```
+
+#### NOTE
+Be careful if we want to use remove multiple array the results will be different from what is expected because at the first opportunity it will change the array order
+
+for example the original json:
+```
+"required": [
+  "validateOnly",
+  "code",
+  "contactType",
+  "languageTag"
+]
+```
+
+what we expect:
+```
+"required": [
+  "code",
+  "languageTag"
+]
+```
+
+patch:
+```
+{
+  "op": "remove",
+  "path": "/required/0"
+},
+{
+  "op": "remove",
+  "path": "/required/2"
+}
+```
+
+result:
+```
+"required": [
+  "code",
+  "contactType"
+]
+```
+
+So instead of doing multiple removes on array it's better to use replace operation
+
+patch: 
+```
+{
+  "op": "replace",
+  "path": "/required",
+  "value": [
+    "code",
+    "languageTag"
+  ]
+}
+```

package/README.md

@@ -1,143 +1,39 @@
-# Odin Code Generator
+# AccelByte Code Generator
 
-Odin Code Generator is a utility tool to generate network calls in Typescript for each of the endpoints on Swagger's JSON document found in Justice backend services
+AccelByte Code Generator is a CLI tool that facilitates creating an AccelByte Web SDK from AccelByte OpenAPI definitions.
 
-To generate/regenerate the network call functions, run `yarn build:codegen` from the root directory (it won't work if it were inside `packages/od-codegen`). That command will check for every JSON inside the directory `packages/od-codegen/src/swaggers`. And will produce/update the files in `/accelbyte-web-sdk/packages/sdk/src/generated`
+## CLI
+This codegen build a CLI called `accelbyte-codegen` that will be used to generate code from given config.
 
-## JSON Patch
-Inside the directory `packages/od-codegen/src/swaggers`, there are also JSON Patch that will patch the Swagger document. The patches will adjust the endpoints so that it will produce the proper functions to match the actual backend service. 
-We use https://github.com/Starcounter-Jack/JSON-Patch library that follow https://jsonpatch.com/ format
-
-### Operations
-#### Add
-```
-{ "op": "add", "path": "/biscuits/1", "value": { "name": "Ginger Nut" } }
-```
-Adds a value to an object or inserts it into an array. In the case of an array, the value is inserted before the given index. The - character can be used instead of an index to insert at the end of an array.
-
-#### Remove
-```
-{ "op": "remove", "path": "/biscuits" }
-```
-Removes a value from an object or array.
-```
-{ "op": "remove", "path": "/biscuits/0" }
-```
-Removes the first element of the array at biscuits (or just removes the “0” key if biscuits is an object)
-
-#### Replace
-```
-{ "op": "replace", "path": "/biscuits/0/name", "value": "Chocolate Digestive" }
-```
-Replaces a value. Equivalent to a “remove” followed by an “add”.
-
-#### Copy
-```
-{ "op": "copy", "from": "/biscuits/0", "path": "/best_biscuit" }
-```
-Copies a value from one location to another within the JSON document. Both from and path are JSON Pointers.
-
-#### Move
-```
-{ "op": "move", "from": "/biscuits", "path": "/cookies" }
-```
-Moves a value from one location to the other. Both from and path are JSON Pointers.
-
-#### Test
-```
-{ "op": "test", "path": "/best_biscuit/name", "value": "Choco Leibniz" }
 ```
-Tests that the specified value is set in the document. If the test fails, then the patch as a whole should not apply.
+Commands:  
+accelbyte-codegen download-swaggers  Download swaggers JSON files  
+accelbyte-codegen generate-code      Generate code based on downloaded swagger
+files
 
-### Example
-For example, take a look at the this object
-```oauthmodel.TokenResponseV3": {
-   "required": [
-    "access_token",
-    "refresh_token",
-    "expires_in",
-    "token_type",
-    "roles",
-    "permissions",
-    "bans",
-    "user_id",
-    "display_name",
-    "namespace",
-    "namespace_roles",
-    "refresh_expires_in",
-    "scope",
-    "xuid"
-   ],
-   // ...
-}
+Options:
+--version           Show version number                                         [boolean]  
+--config            Config file providing backend services URL.                 [string] [required]  
+--swaggersOutput    Output path for downloaded swaggers JSON files.             [string] [required]  
+--output            Output path for generated code. Required for generate-code  [string]  
+--admin             Only generate /admin endpoints.                             [boolean] [default: false]  
+--help              Show help                                                   [boolean]  
 ```
 
-This definition says that `TokenResponseV3` will always give out `xuid`. Yet at the moment, that property shouldn't always appear in the current IAM and the Swagger JSON is mistakenly written that way. If we kept the `xuid` property there, the response validation in Odin Web SDK will throw error and say the response missed the `xuid` property. Therefore, the JSON Patches are created, and it looks like this
+### Config file
+Provide swaggers url you wish to generate, store it in .json format file.
 
 ```
-  {
-    "op": "remove",
-    "path": "/definitions/oauthmodel.TokenResponseV3/required/13"
-  }
-  ```
-
-#### NOTE
-Be careful if we want to use remove multiple array the results will be different from what is expected because at the first opportunity it will change the array order
-
-for example the original json:
-```
-"required": [
-  "validateOnly",
-  "code",
-  "contactType",
-  "languageTag"
-]
-```
-
-what we expect:
-```
-"required": [
-  "code",
-  "languageTag"
-]
-```
-
-patch:
-```
-{
-  "op": "remove",
-  "path": "/required/0"
-},
-{
-  "op": "remove",
-  "path": "/required/2"
-}
-```
-
-result:
-```
-"required": [
-  "code",
-  "contactType"
+[
+  ["iam", "Iam", "iam.json", "https://example.com/iam/apidocs/api.json"]
 ]
 ```
 
-So instead of doing multiple removes on array it's better to use replace operation
-
-patch: 
-```
-{
-  "op": "replace",
-  "path": "/required",
-  "value": [
-    "code",
-    "languageTag"
-  ]
-}
-```
-
-# How to generate
-So the flow to generate/regenerate Swagger JSON, here's what needs to be done.
-1. Download the JSON files and store it `packages/od-codegen/src/swaggers`
-2. Run `yarn build:codegen`
-3. See that `packages/od-web-sdk/src/generated` is changed
+## How to Generate
+1. Provide the `config.json` file
+2. Download swagger files  
+   `accelbyte-codegen download-swaggers --config ./config.json --swaggersOutput ./swaggers`
+3. Generate code from swagger files  
+   `accelbyte-codegen generate-code --config ./config.json --swaggersOutput ./swaggers --output ./sdk`
+4. Prettify the files using
+   `yarn prettier`