Merge pull request #33 from mondaycom/feature/romka/setup-installer-d…

…etection

yarn/npm detection in setup-api

README.md

@@ -2,9 +2,9 @@
 
 This monorepo contains all the packages for the monday.com GraphQL SDKs. Currently, it holds the following packages:
 
-- [@mondaydotcomorg/api](./packages/api)
-- [@mondaydotcomorg/api-types](./packages/api-types)
-- [@mondaydotcomorg/setup-api](./packages/setup-api)
+- [@mondaydotcomorg/api](./packages/api) - Our official sdk, used to make api calls
+- [@mondaydotcomorg/api-types](./packages/api-types) - Types
+- [@mondaydotcomorg/setup-api](./packages/setup-api) - After installing the api, use this to setup typed api environment
 
 ## Usage of generated code
 

packages/api/README.md

@@ -105,3 +105,11 @@ export const getBoards = gql`
 
 const data = await SeamlessApiClient.query<GetBoardsQuery>(getBoards, variables);
 ```
+
+### Type support
+
+note that after usage, you'l get all the available fields, with no regard to the fields you asked for
+
+![alt text](./public/image.png)
+
+**But there's a solution, look [here!](https://www.npmjs.com/package/@mondaydotcomorg/setup-api)**

packages/api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondaydotcomorg/api",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "monday.com API client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -37,7 +37,6 @@
     "graphql-tag": "^2.12.6"
   },
   "devDependencies": {
-    "moment": "^2.30.1",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
@@ -46,6 +45,7 @@
     "@types/jest": "^29.5.12",
     "@types/node": "^20.11.18",
     "jest": "^29.7.0",
+    "moment": "^2.30.1",
     "rollup": "^2.79.1",
     "rollup-plugin-delete": "^2.0.0",
     "rollup-plugin-dts": "^4.2.3",

packages/setup-api/README.md

@@ -4,6 +4,16 @@
 
 This library automates the setup of a development environment for working with the Monday API using GraphQL. It's designed to help developers quickly start projects with pre-configured tools and settings.
 
+## Whats the end result?
+
+You can start writing qeuries with auto complete on the types of your queries
+
+![alt text](./public/image-1.png)
+
+After usage, you can get only what you asked for
+
+![alt text](./public/image-2.png)
+
 ## What does the script do?
 
 The script gets the environment ready for graphql api development

packages/setup-api/lib/index.ts

@@ -3,13 +3,20 @@
 import * as shell from 'shelljs';
 import * as fs from 'fs';
 
-export const installPackages = () => {
-  const commands = [
-    'npm install graphql-request',
-    'npm install --save-dev @graphql-codegen/cli @graphql-codegen/typescript @graphql-codegen/typescript-operations',
-  ];
+const isYarn = fs.existsSync('yarn.lock');
+
+const installCommands = isYarn
+  ? [
+      'yarn add graphql-request',
+      'yarn add -D @graphql-codegen/cli @graphql-codegen/typescript @graphql-codegen/typescript-operations',
+    ]
+  : [
+      'npm install graphql-request',
+      'npm install --save-dev @graphql-codegen/cli @graphql-codegen/typescript @graphql-codegen/typescript-operations',
+    ];
 
-  commands.forEach((command) => {
+export const installPackages = () => {
+  installCommands.forEach((command) => {
     if (shell.exec(command).code !== 0) {
       console.error(`Error executing command: ${command}`);
       shell.exit(1);

packages/setup-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondaydotcomorg/setup-api",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "monday.com setup api cli",
   "main": "dist/cjs/index.js",
   "types": "dist/cjs/index.d.ts",

packages/setup-api/tests/setup-graphql.test.ts

@@ -2,10 +2,16 @@ import { createFiles, installPackages, updatePackageJsonScripts } from '../lib/i
 import * as shell from 'shelljs';
 import * as fs from 'fs';
 
+const useYarn = shell.which('yarn');
+const packageManager = useYarn ? 'yarn' : 'npm';
+const installCommand = useYarn ? 'add' : 'install';
+const devFlag = useYarn ? '-D' : '--save-dev';
+
 jest.mock('shelljs', () => ({
   exec: jest.fn().mockReturnValue({ code: 0 }),
   exit: jest.fn(),
   mkdir: jest.fn(),
+  which: jest.fn().mockReturnValue(true),
 }));
 
 jest.mock('fs', () => ({
@@ -20,16 +26,18 @@ describe('setupGraphQL', () => {
     jest.clearAllMocks();
   });
 
-  it('should execute npm install commands', () => {
+  it('should install the necessary packages with appropriate package manager', () => {
     installPackages();
-    expect(shell.exec).toHaveBeenCalledWith(expect.stringContaining('npm install graphql-request'));
+
+    expect(shell.exec).toHaveBeenCalledWith(
+      expect.stringContaining(`${packageManager} ${installCommand} graphql-request`),
+    );
     expect(shell.exec).toHaveBeenCalledWith(
       expect.stringContaining(
-        'npm install --save-dev @graphql-codegen/cli @graphql-codegen/typescript @graphql-codegen/typescript-operations',
+        `${packageManager} ${installCommand} ${devFlag} @graphql-codegen/cli @graphql-codegen/typescript @graphql-codegen/typescript-operations`,
       ),
     );
   });
-
   it('should create necessary files', () => {
     createFiles();
     expect(fs.writeFileSync).toHaveBeenCalledWith('codegen.yml', expect.any(String));