@manot40/genql-cli 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Tommaso De Rossi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,108 @@
+<div align='center'>
+    <br/>
+    <br/>
+    <img src='https://genql.dev/banner.png' width='380px'>
+    <br/>
+    <br/>
+    <h3>Type safe Graphql query builder</h3>
+    <h4>Write Graphql queries with type validation and auto completion</h4>
+    <br/>
+    <br/>
+</div>
+
+> [!IMPORTANT]
+> Genql is building a cloud platform to automate SDK generation in multiple languages, docs website with examples, changelog website and more. 
+> Fill [this form](https://tally.so/r/mK1GWM) if you are interested!
+
+Read the [quick start guide](https://genql.dev/docs) to generate your client and start writing queries.
+
+You can stay up to date with the latest changes subscribing to the [Genql changelog](https://changelog.genql.dev).
+
+**Features**
+
+-   ✅ Type completion & Type validation
+-   🍃 No dependencies (not even graphql)
+-   ⚡️ [Can easily fetch all scalar fields in a type](https://genql.dev/docs/usage/fetch-all-fields-on-a-type)
+-   🐎 [Works with any client (Apollo, Relay, etc)](https://genql.dev/docs/usage/integrate-with-other-graphql-clients)
+-   🥃 [Support for Subscriptions](https://genql.dev/docs/usage/subscriptions)
+-   🔋 [Built in batching support](https://genql.dev/docs/usage/batching-queries)
+-   ↔️ [Easy migrate existing GraphQL queries to Genql code](https://genql.dev/converter)
+-   🚂 Works in browser, Node, Deno, Cloudflare workers, Bun and more
+
+## Example
+
+First generate your client with the `genql` cli.
+
+> You can find other cli options [here](https://genql.dev/docs/cli-reference)
+
+```sh
+npm i -D @genql/cli # cli to generate the client code
+genql --schema ./schema.graphql --output ./generated
+```
+
+Then you can use your client as follow
+
+```js
+import { createClient, everything } from './generated'
+const client = createClient()
+
+client
+    .query({
+        countries: {
+            // pass arguments to the query
+            __args: {
+                filter: {
+                    currency: {
+                        eq: 'EUR',
+                    },
+                },
+            },
+            name: true,
+            code: true,
+            nestedField: {
+                // fetch all scalar fields
+                __scalar: true,
+            },
+        },
+    })
+    .then(console.log)
+```
+
+The code above will fetch the graphql query below
+
+```graphql
+query {
+    countries(filter: { currency: { eq: "EUR" } }) {
+        name
+        code
+        nestedField {
+            scalarField1
+            scalarField2
+        }
+    }
+}
+```
+
+## Why
+
+Genql has a lot of benefits over writing graphql queries by hand:
+
+-   Writing queries is faster thanks to TypeScript auto completion
+-   You can safely update your schema and be sure your queries are still valid
+-   You can fetch all scalar fields in a type with `__scalar: true`
+-   No `graphql` package dependency, no runtime parsing of queries
+-   You have to generate the client only after your schema changes, not after every query change
+
+---
+
+## Sponsors
+
+[**Notaku**](https://notaku.so)
+
+[![Notaku](https://notaku.so/github_banner.jpg)](https://notaku.so)
+
+[![Vercel](https://genql.dev/vercel-logo.svg)](https://vercel.com?utm_source=genql)
+
+---
+
+[Licensed under MIT]().

package/dist/cli.d.mts

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+//#region src/cli.d.ts
+declare function printHelp({
+  dirPath
+}: {
+  dirPath: any;
+}): void;
+//#endregion
+export { printHelp };

package/dist/cli.mjs

@@ -0,0 +1,121 @@
+#!/usr/bin/env node
+import { t as generate } from "./main-BVWRj669.mjs";
+import kleur from "kleur";
+import yargs from "yargs";
+import { existsSync, readFileSync } from "fs";
+
+//#region src/tasks/validateConfigs.ts
+const validateConfigs = (configs) => {
+	const errors = [];
+	if (configs.length === 0) errors.push("config array is empty");
+	configs.forEach((config$1, i) => {
+		const whichConfig = configs.length === 1 ? "the config" : `config #${i + 1}`;
+		if (!config$1.endpoint && !config$1.schema) errors.push(`you didn't provide either \`endpoint\`, \`schema\` or \`fetcher\` option in ${whichConfig}`);
+		if ([config$1.endpoint, config$1.schema].filter((i$1) => i$1).length > 1) errors.push(`you provided two or more conflicting options in ${whichConfig}, only one of either \`endpoint\`, \`schema\` or \`fetcher\` is allowed`);
+		if (!config$1.output) errors.push(`you didn't provide an \`output\` option in ${whichConfig}`);
+	});
+	errors.forEach((error) => console.log(kleur.red(`Error: ${error}`)));
+	return errors.length === 0;
+};
+
+//#endregion
+//#region src/helpers/parse.ts
+function parseColonSeparatedStrings(array = []) {
+	let obj = {};
+	for (let h of array) {
+		const key = String(h).substring(0, h.indexOf(":")).trim();
+		const value = h.substring(h.indexOf(":") + 1).trim();
+		if (!key || !value) {
+			console.error(`cannot parse string '${h}' as key:value pair`);
+			process.exit(1);
+		}
+		obj[key] = value;
+	}
+	return obj;
+}
+
+//#endregion
+//#region src/cli.ts
+const program = yargs(process.argv.slice(2)).option("output", {
+	alias: "o",
+	description: "Output directory",
+	required: true,
+	type: "string"
+}).option("endpoint", {
+	alias: "e",
+	description: "Graphql endpoint",
+	type: "string"
+}).option("get", {
+	alias: "g",
+	description: "use GET for introspection query",
+	type: "boolean"
+}).option("schema", {
+	alias: "s",
+	type: "string",
+	description: "path to GraphQL schema definition file"
+}).option("header", {
+	alias: "H",
+	type: "array",
+	string: true,
+	description: "header to use in introspection query"
+}).option("scalar", {
+	alias: "S",
+	type: "array",
+	string: true,
+	description: "map a scalar to a type, for example `-S DateTime:string` "
+}).option("sort", {
+	type: "boolean",
+	default: false,
+	description: "sort object properties to not create diffs after generations"
+}).option("verbose", {
+	alias: "v",
+	type: "boolean",
+	default: false
+}).example("$0 --output ./generated --endpoint http://localhost:3000  -H \"Authorization: Bearer xxx\"", "generate the client from an endpoint").example("$0 --output ./generated --schema ./schema.graphql", "generate the client from a schema").option("esm", {
+	type: "boolean",
+	hidden: true,
+	deprecate: "No longer used",
+	default: false,
+	description: ""
+}).option("esm-and-cjs", {
+	type: "boolean",
+	hidden: true,
+	deprecated: true,
+	deprecate: "No longer used",
+	default: false,
+	description: ""
+}).help("help").help("h").argv;
+const config = {
+	endpoint: program.endpoint,
+	useGet: program.get,
+	schema: program.schema && readFile(program.schema),
+	output: program.output,
+	headers: parseColonSeparatedStrings(program.header || []),
+	scalarTypes: parseColonSeparatedStrings(program.scalar || []),
+	verbose: program.verbose,
+	sortProperties: program.sort
+};
+if (!validateConfigs([config])) process.exit(1);
+generate(config).catch((e) => {
+	console.error(kleur.red("Cannot generate, got an error:"));
+	console.error(e);
+	process.exit(1);
+}).then(() => {
+	printHelp({ dirPath: program.output });
+});
+function printHelp({ dirPath }) {
+	console.log();
+	console.log(`${kleur.green("Success!")} Generated client code inside '${dirPath}'`);
+	console.log();
+	console.log();
+}
+function readFile(p) {
+	if (!existsSync(p)) {
+		console.log(`file '${p}' does not exist`);
+		process.exit(1);
+	}
+	return readFileSync(p).toString();
+}
+
+//#endregion
+export { printHelp };

package/dist/index.d.mts

@@ -0,0 +1,19 @@
+//#region src/config.d.ts
+interface Config {
+  verbose?: boolean;
+  endpoint?: string;
+  useGet?: boolean;
+  schema?: string;
+  output?: string;
+  headers?: Record<string, string>;
+  scalarTypes?: {
+    [k: string]: string;
+  };
+  fetchImport?: string;
+  sortProperties?: boolean;
+}
+//#endregion
+//#region src/main.d.ts
+declare const generate: (config: Config) => Promise<void>;
+//#endregion
+export { generate };

package/dist/index.mjs

@@ -0,0 +1,3 @@
+import { t as generate } from "./main-BVWRj669.mjs";
+
+export { generate };