@accelbyte/codegen 1.0.0-alpha.1

package/CHANGELOG.md

@@ -0,0 +1,40 @@
+### 2022-11-23
+
+- CW-1697 - Prettify config files
+
+### 2022-09-7
+
+- CW-1449 - [WebSDK] WebSDK accepts cache argument at initialization
+
+### 2022-09-19
+
+- CW-1034 - [Basic] dateOfBirth patten in basic service
+- CW-1035 - [Basic] Language pattern in basic service
+
+### 2022-09-19
+
+- CW-1225 - [WebSDK] Add Cache in WebSDK
+
+### 2022-09-16
+
+- CW-1007 - CW-1008 CW-1009 - remove patches containing language patterns, WalletInfo definition, and OrderInfo definition
+
+### 2022-08-04
+
+- OS-7129 - [Dev][Player Portal] Add a redirection page for user verification through link
+
+### 2022-07-29
+
+- CW-753 - [Editor][PP][Launcher] Migrate Editor, PP and Launcher to the latest Config-Service endpoints
+
+### 2022-07-27
+
+- Update the typings for `config.data` for Odin Config Web SDK
+
+### 2022-07-26
+
+- CW-636 - [WebSDK] Web SDK is updated with new config-service endpoints
+
+### 2022-07-14
+
+- CW-300 - [Technical] Audit and Remove unused NPM dependencies

package/README.md

@@ -0,0 +1,143 @@
+# Odin 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
+
+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`
+
+## 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 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
+
+```
+  {
+    "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"
+  ]
+}
+```
+
+# 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