add playground folder, rename template

Author: shortcuts

README.md

@@ -18,10 +18,14 @@ yarn generate
 yarn client:build
 ```
 
-## Test JavaScript client locally
+# Testing clients
+
+Go to the [`playground`](./playground) folder to test your client
+
+## JavaScript
 
 ```bash
-yarn client:test
+cd playground/javascript && yarn start
 ```
 
 # Troubleshooting

clients/algoliasearch-client-javascript/package.json

@@ -14,8 +14,8 @@
     "test": "yarn build && node dist/client.js"
   },
   "engines": {
-    "node": ">= 16.0.0",
-    "yarn": ">= 3.0.0"
+    "node": "^16.0.0",
+    "yarn": "^3.0.0"
   },
   "devDependencies": {
     "@types/node": "^16.11.6",

openapitools.json

@@ -5,7 +5,7 @@
     "generators": {
       "javascript-client": {
         "generatorName": "typescript-node",
-        "templateDir": "#{cwd}/templates/javascript-client-template/",
+        "templateDir": "#{cwd}/templates/javascript/",
         "config": "#{cwd}/openapitools.json",
         "apiPackage": "client-search",
         "output": "#{cwd}/clients/algoliasearch-client-javascript",

package.json

@@ -1,34 +1,31 @@
 {
   "name": "@algolia/api-client-automation",
   "version": "0.0.0",
-  "workspaces": [
-    "clients/*"
-  ],
+  "workspaces": {
+    "packages": [
+      "clients/algoliasearch-client-javascript/",
+      "playground/javascript/"
+    ]
+  },
   "scripts": {
     "build:spec": "yarn swagger-cli bundle openapi_spec/spec.yml --outfile dist/openapi.yml --type yaml",
-    "clean:clients": "rm -rf clients/algoliasearch-*/*",
     "clean": "rm -rf **/dist **/build **/node_modules",
     "client:build-js": "cd clients/algoliasearch-client-javascript/ && yarn install && yarn build && cd ../../",
     "client:build": "yarn client:build-js",
-    "client:test": "yarn install && tsc && node dist/app.js",
-    "client": "yarn client:build && yarn client:test",
     "lint:js": "yarn prettier --write clients/algoliasearch-client-javascript clients/utils/javascript",
     "lint:specs": "yarn prettier --write specs",
     "lint": "yarn lint:specs && yarn lint:js",
-    "generate:js": "PACKAGE_VERSION='4.11.0' yarn openapi-generator-cli generate --generator-key javascript-client && yarn utils:import-js",
+    "generate:js": "PACKAGE_VERSION='4.11.0' yarn openapi-generator-cli generate --generator-key javascript-client && yarn install && yarn utils:import-js",
     "generate": "yarn generate:js && yarn lint",
     "utils:import-js": "mkdir -p -- clients/algoliasearch-client-javascript/utils && cp -R clients/utils/javascript/ clients/algoliasearch-client-javascript/utils"
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "^2.4.13",
-    "algoliasearch-client-javascript": "file:clients/algoliasearch-client-javascript/",
-    "dotenv": "10.0.0",
     "prettier": "2.4.1",
-    "swagger-cli": "^4.0.4",
-    "typescript": "4.5.2"
+    "swagger-cli": "^4.0.4"
   },
   "engines": {
-    "node": ">= 12.0.0",
-    "yarn": ">= 2.0.0"
+    "node": "^16.0.0",
+    "yarn": "^3.0.0"
   }
 }

.env.example renamed to playground/javascript/.env.example

@@ -0,0 +1,19 @@
+{
+  "name": "algoliasearch-client-javascript-playground",
+  "version": "0.0.0",
+  "scripts": {
+    "build": "tsc",
+    "start": "yarn install && yarn build && yarn test",
+    "test": "node dist/app.js"
+  },
+  "devDependencies": {
+    "algoliasearch-client-javascript": "5.0.0",
+    "dotenv": "10.0.0",
+    "prettier": "2.4.1",
+    "typescript": "4.5.2"
+  },
+  "engines": {
+    "node": "^16.0.0",
+    "yarn": "^3.0.0"
+  }
+}

app.ts renamed to playground/javascript/app.ts

@@ -14,8 +14,8 @@
     "test": "yarn build && node dist/client.js"
   },
   "engines": {
-    "node": ">= 16.0.0",
-    "yarn": ">= 3.0.0"
+    "node": "^16.0.0",
+    "yarn": "^3.0.0"
   },
   "devDependencies": {
     "@types/node": "^16.11.6",

playground/javascript/package.json

@@ -10,11 +10,8 @@ __metadata:
   resolution: "@algolia/api-client-automation@workspace:."
   dependencies:
     "@openapitools/openapi-generator-cli": ^2.4.13
-    algoliasearch-client-javascript: "file:clients/algoliasearch-client-javascript/"
-    dotenv: 10.0.0
     prettier: 2.4.1
     swagger-cli: ^4.0.4
-    typescript: 4.5.2
   languageName: unknown
   linkType: soft
 
@@ -81,11 +78,11 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@nestjs/common@npm:8.0.9":
-  version: 8.0.9
-  resolution: "@nestjs/common@npm:8.0.9"
+"@nestjs/common@npm:8.2.2":
+  version: 8.2.2
+  resolution: "@nestjs/common@npm:8.2.2"
   dependencies:
-    axios: 0.21.4
+    axios: 0.24.0
     iterare: 1.2.1
     tslib: 2.3.1
     uuid: 8.3.2
@@ -102,13 +99,13 @@ __metadata:
       optional: true
     class-validator:
       optional: true
-  checksum: 7b5df099b9b54770b10420b096df580d91eb889706787efd9928ce7f6ea6ecb829ff0ae29a7af9c95b78687be37824296afc296ee316b713e93e43a8422647c9
+  checksum: 5d74143630d9bbe28d18bb9c47a948f84c2b62aed0974de0963ec3e94da9964b9b214da3622b4b6970456dfe03dc12439728c57570ffca5e2283b4fe3ac6daee
   languageName: node
   linkType: hard
 
-"@nestjs/core@npm:8.0.9":
-  version: 8.0.9
-  resolution: "@nestjs/core@npm:8.0.9"
+"@nestjs/core@npm:8.2.2":
+  version: 8.2.2
+  resolution: "@nestjs/core@npm:8.2.2"
   dependencies:
     "@nuxtjs/opencollective": 0.3.2
     fast-safe-stringify: 2.1.1
@@ -131,7 +128,7 @@ __metadata:
       optional: true
     "@nestjs/websockets":
       optional: true
-  checksum: 65f481ef03b0432c89d0905b459084cb9839ea88e6ff56bf5b4f9e5a70823d681e8aebdeddcb19bebde71ace557123734fa7e884ed27814b433cb93318591a1e
+  checksum: 5dee8d70b9c8e09c3810f028fdaa91b0025fd11bf2fd47b74d44ee44b6cce9245709f3b69a1661be23ba67688ed67eeb85770a2d0c1812534429976ba103d8e8
   languageName: node
   linkType: hard
 
@@ -149,16 +146,16 @@ __metadata:
   linkType: hard
 
 "@openapitools/openapi-generator-cli@npm:^2.4.13":
-  version: 2.4.13
-  resolution: "@openapitools/openapi-generator-cli@npm:2.4.13"
+  version: 2.4.17
+  resolution: "@openapitools/openapi-generator-cli@npm:2.4.17"
   dependencies:
-    "@nestjs/common": 8.0.9
-    "@nestjs/core": 8.0.9
+    "@nestjs/common": 8.2.2
+    "@nestjs/core": 8.2.2
     "@nuxtjs/opencollective": 0.3.2
     chalk: 4.1.2
     commander: 8.3.0
     compare-versions: 3.6.0
-    concurrently: 6.3.0
+    concurrently: 6.4.0
     console.table: 0.10.0
     fs-extra: 10.0.0
     glob: 7.1.6
@@ -169,7 +166,7 @@ __metadata:
     tslib: 2.0.3
   bin:
     openapi-generator-cli: main.js
-  checksum: a2f0a82a4e97bfc13f703aac28b52b811b2528a5d7e923adeba3a376281324f53337bb6a93d9f1e8fc8a9f2305bd8a8d112f8f2d00f47aee1a488fdf68fff12c
+  checksum: 6d344ef62e4647e3c830f1463deb320e07dfc33ba09016d2488c28f13b71dfccc2b4d4f02ee1252102f8dd1f2bac98b440fa1824ba24efef40d7b4def5cd073b
   languageName: node
   linkType: hard
 
@@ -181,20 +178,24 @@ __metadata:
   linkType: hard
 
 "@types/node@npm:^16.11.6":
-  version: 16.11.7
-  resolution: "@types/node@npm:16.11.7"
-  checksum: 2706403e6efc4aa40fdce8f0b5d9884d5600c3c8610aedc7fa5e7e298d30366f7e8b7296028d52898dca3edef4c3e827b03bf20952c4780f13fa4e79864f7a86
+  version: 16.11.9
+  resolution: "@types/node@npm:16.11.9"
+  checksum: baec2e6471ee58fd1e9874e6f47ab95a918a0f46b42424392e4c13e3e07f078f8b72b6b48073b0b14f710ed66c5f1b2e497df43f28151000f11f5f299382cfe2
   languageName: node
   linkType: hard
 
-"algoliasearch-client-javascript@file:clients/algoliasearch-client-javascript/::locator=%40algolia%2Fapi-client-automation%40workspace%3A.":
-  version: 5.0.0
-  resolution: "algoliasearch-client-javascript@file:clients/algoliasearch-client-javascript/#clients/algoliasearch-client-javascript/::hash=15f8cd&locator=%40algolia%2Fapi-client-automation%40workspace%3A."
-  checksum: a9c0396026c208de698f1d27213707e5d52a5efd9ae060ac1ae795e83e628cb27e27dee208c51199f5c2633aad82864ced200c0231474fd9cec8d003a1a23d5f
-  languageName: node
-  linkType: hard
+"algoliasearch-client-javascript-playground@workspace:playground/javascript":
+  version: 0.0.0-use.local
+  resolution: "algoliasearch-client-javascript-playground@workspace:playground/javascript"
+  dependencies:
+    algoliasearch-client-javascript: 5.0.0
+    dotenv: 10.0.0
+    prettier: 2.4.1
+    typescript: 4.5.2
+  languageName: unknown
+  linkType: soft
 
-"algoliasearch-client-javascript@workspace:clients/algoliasearch-client-javascript":
+"algoliasearch-client-javascript@5.0.0, algoliasearch-client-javascript@workspace:clients/algoliasearch-client-javascript":
   version: 0.0.0-use.local
   resolution: "algoliasearch-client-javascript@workspace:clients/algoliasearch-client-javascript"
   dependencies:
@@ -244,12 +245,12 @@ __metadata:
   languageName: node
   linkType: hard
 
-"axios@npm:0.21.4":
-  version: 0.21.4
-  resolution: "axios@npm:0.21.4"
+"axios@npm:0.24.0":
+  version: 0.24.0
+  resolution: "axios@npm:0.24.0"
   dependencies:
-    follow-redirects: ^1.14.0
-  checksum: 44245f24ac971e7458f3120c92f9d66d1fc695e8b97019139de5b0cc65d9b8104647db01e5f46917728edfc0cfd88eb30fc4c55e6053eef4ace76768ce95ff3c
+    follow-redirects: ^1.14.4
+  checksum: 468cf496c08a6aadfb7e699bebdac02851e3043d4e7d282350804ea8900e30d368daa6e3cd4ab83b8ddb5a3b1e17a5a21ada13fc9cebd27b74828f47a4236316
   languageName: node
   linkType: hard
 
@@ -425,9 +426,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"concurrently@npm:6.3.0":
-  version: 6.3.0
-  resolution: "concurrently@npm:6.3.0"
+"concurrently@npm:6.4.0":
+  version: 6.4.0
+  resolution: "concurrently@npm:6.4.0"
   dependencies:
     chalk: ^4.1.0
     date-fns: ^2.16.1
@@ -439,7 +440,7 @@ __metadata:
     yargs: ^16.2.0
   bin:
     concurrently: bin/concurrently.js
-  checksum: fb68236899259a3b0c05d27db608ee9150f11fc785552c14937e5e1421c9448d03704cdc2acb5f842a91c465d50005b4229f348eb9594d84cbef54e5a93ffde7
+  checksum: 902864cc853176cac406246fa367a1b24ebfcbea9ba43c164f9cb4e2c9c1a5f9d8be05ce98fe7ef13329ffd5cc340a052007a9c870863e2068425d95b3bf89d7
   languageName: node
   linkType: hard
 
@@ -460,9 +461,9 @@ __metadata:
   linkType: hard
 
 "date-fns@npm:^2.16.1":
-  version: 2.25.0
-  resolution: "date-fns@npm:2.25.0"
-  checksum: 8896dc1dde0ee5ef77616942423bfa11fa2017a5ac19457293b7aaedc8822ff94f0a14eaf93da573b09b601dc0149eb430988a046cc9f79a2eb15f8c66c9c50c
+  version: 2.26.0
+  resolution: "date-fns@npm:2.26.0"
+  checksum: 49ad59bc788134a6552ef4e4af0d18792001c1ca0070d543de4f36aba5761058b6e6a57b8ca51dd3b0f07f3bd55376b8bc69602bd7940648ba3869c5253c6ae8
   languageName: node
   linkType: hard
 
@@ -569,7 +570,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"follow-redirects@npm:^1.14.0":
+"follow-redirects@npm:^1.14.4":
   version: 1.14.5
   resolution: "follow-redirects@npm:1.14.5"
   peerDependenciesMeta:
@@ -1016,9 +1017,9 @@ __metadata:
   linkType: hard
 
 "signal-exit@npm:^3.0.2":
-  version: 3.0.5
-  resolution: "signal-exit@npm:3.0.5"
-  checksum: a1d3d0d63f581bd298b30ed8f6de21b73a0fe5a0c0f123b2e8ed7168bbff8f4c1a45e681de12a1966a89bb725d8eb727816be1c436e136951f31953e4a201587
+  version: 3.0.6
+  resolution: "signal-exit@npm:3.0.6"
+  checksum: b819ac81ba757af559dad0804233ae31bf6f054591cd8a671e9cbcf09f21c72ec3076fe87d1e04861f5b33b47d63f0694b568de99c99cd733ee2060515beb6d5
   languageName: node
   linkType: hard
 
@@ -1204,7 +1205,7 @@ [email protected]:
   languageName: node
   linkType: hard
 
-"validator@npm:^13.6.0":
+"validator@npm:^13.7.0":
   version: 13.7.0
   resolution: "validator@npm:13.7.0"
   checksum: 2b83283de1222ca549a7ef57f46e8d49c6669213348db78b7045bce36a3b5843ff1e9f709ebf74574e06223461ee1f264f8cc9a26a0060a79a27de079d8286ef
@@ -1339,18 +1340,18 @@ [email protected]:
   linkType: hard
 
 "z-schema@npm:^5.0.1":
-  version: 5.0.1
-  resolution: "z-schema@npm:5.0.1"
+  version: 5.0.2
+  resolution: "z-schema@npm:5.0.2"
   dependencies:
     commander: ^2.7.1
     lodash.get: ^4.4.2
     lodash.isequal: ^4.5.0
-    validator: ^13.6.0
+    validator: ^13.7.0
   dependenciesMeta:
     commander:
       optional: true
   bin:
     z-schema: bin/z-schema
-  checksum: 9e825d3c426efe65291c84178139b1a3dd08f9e70a6ba2844c3125d97c140abedf5f6799e05c22e9dc4ce005b49db3ca916e9dc6d98d903086a75fe256fef067
+  checksum: 084b2f16043ac0a892914ee29cc0b4fafd9338133eec0345cd6ced25e814f647fa67be1090ad5f606759c2c1f2f8c28127960ba187f437f1caf6fb8cd45d7336
   languageName: node
   linkType: hard