b-gsdk 0.1.2 → 0.1.5

package/dist/index.js

@@ -17,7 +17,7 @@ async function main(args) {
     const config = (0, get_b_gsdk_config_1.getBGsdkConfig)(bgsdkDirectoryPath);
     const [schemaCodegen, sdkCodegen] = await (0, cli_1.generate)({
         schema: {
-            [config.schemaURL]: {
+            [config.endpoint]: {
                 headers: config.headers,
             },
         },
@@ -44,19 +44,11 @@ async function main(args) {
     }, false);
     createDirIfDoesNotExist(`${bgsdkDirectoryPath}/generated`);
     fs_1.default.writeFileSync(path_1.default.join(bgsdkDirectoryPath, "generated/graphql.schema.json"), schemaCodegen.content);
-    fs_1.default.writeFileSync(path_1.default.join(bgsdkDirectoryPath, "generated/index.ts"), sdkCodegen.content);
+    fs_1.default.writeFileSync(path_1.default.join(bgsdkDirectoryPath, "generated/index.ts"), "/* eslint-disable */\n" + sdkCodegen.content + "\n" + extraGenerated);
     const skdFilePath = path_1.default.join(bgsdkDirectoryPath, "sdk.ts");
     if (!fs_1.default.existsSync(skdFilePath)) {
         fs_1.default.writeFileSync(skdFilePath, sdkFileContents);
     }
-    const gitignorePath = path_1.default.join(process.cwd(), ".gitignore");
-    if (fs_1.default.existsSync(gitignorePath)) {
-        const gitignore = fs_1.default.readFileSync(gitignorePath, "utf8");
-        if (!gitignore.includes("generated")) {
-            fs_1.default.appendFileSync(gitignorePath, "\ngenerated/");
-            console.log('Added "generated/" to .gitignore');
-        }
-    }
     console.log("Done ✨");
 }
 exports.main = main;
@@ -65,15 +57,15 @@ function createDirIfDoesNotExist(p) {
         fs_1.default.mkdirSync(p);
     }
 }
-const sdkFileContents = `import { GraphQLClient } from 'graphql-request'
-import { getSdk } from './generated'
-
-export type CreateBGsdkClientParams = {
+const extraGenerated = `export type CreateBgSdkParams = {
   endpoint: string
   headers?: string[][] | Record<string, string> | Headers
 }
 
-export const createBGsdk = ({ endpoint, headers }: CreateBGsdkClientParams) => {
+export const createBgSdk = ({
+  endpoint,
+  headers
+}: CreateBgSdkParams) => {
   const graphQLClient = new GraphQLClient(endpoint, {
     headers: {
       accept: 'application/json',
@@ -84,11 +76,12 @@ export const createBGsdk = ({ endpoint, headers }: CreateBGsdkClientParams) => {
 
   const generatedSdk = getSdk(graphQLClient)
 
-  return { ...generatedSdk, rawClient: graphQLClient }
+  return { ...generatedSdk, client: graphQLClient }
 }
+`;
+const sdkFileContents = `import config from './config'
+import { createBgSdk } from './generated'
 
-// You can then create the sdk with the endpoint and headers set up and export it.
-// For example like this:
-// export const bgsdk = createBGsdk({ })
+export const bgSdk = createBgSdk(config)
 
 `;

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "b-gsdk",
-  "version": "0.1.2",
+  "version": "0.1.5",
   "description": "A GraphQL Codegen that outputs a TypeScript SDK.",
   "author": "Julian Benegas",
   "license": "MIT",
   "main": "dist/index.js",
   "bin": "dist/bin.js",
+  "types": "src/index.d.ts",
   "scripts": {
     "build": "tsc",
     "prepublish": "yarn build"
@@ -17,6 +18,7 @@
     "@graphql-codegen/typescript-graphql-request": "^4.3.2",
     "@graphql-codegen/typescript-operations": "^2.2.1",
     "arg": "^5.0.1",
+    "dotenv": "^16.0.0",
     "zod": "^3.14.4"
   },
   "peerDependencies": {
@@ -30,8 +32,5 @@
     "graphql": "^16.3.0",
     "ts-node": "^10.7.0",
     "typescript": "^4.6.3"
-  },
-  "engines": {
-    "node": ">=16.0.0"
   }
 }

package/src/bin.ts

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+require("dotenv").config();
 import { main } from ".";
 import { formatError } from "./util/format-error";
 import arg from "arg";
@@ -28,14 +29,23 @@ const args = arg(
 );
 
 // CLI commands
-const cmds: { [key: string]: (args: Args) => void } = {
+const cmds: { [key: string]: (args: Args) => Promise<void> } = {
   generate: main,
 };
 
 // Run CLI
 try {
   // Run command or show usage for unknown command
-  cmds[cmd] ? cmds[cmd](args) : help(0);
+  cmds[cmd]
+    ? cmds[cmd](args)
+        .then(() => {
+          process.exit(0);
+        })
+        .catch((error) => {
+          console.error(formatError(error));
+          process.exit(1);
+        })
+    : help(0);
 } catch (e) {
   console.error(formatError(e).message);
   process.exit(1);

package/src/index.d.ts

@@ -0,0 +1 @@
+export { BGsdkConfig } from "./util/get-b-gsdk-config";

package/src/index.ts

@@ -22,7 +22,7 @@ export async function main(args: Args) {
   const [schemaCodegen, sdkCodegen] = await generate(
     {
       schema: {
-        [config.schemaURL]: {
+        [config.endpoint]: {
           headers: config.headers,
         },
       },
@@ -57,22 +57,13 @@ export async function main(args: Args) {
   );
   fs.writeFileSync(
     path.join(bgsdkDirectoryPath, "generated/index.ts"),
-    sdkCodegen.content
+    "/* eslint-disable */\n" + sdkCodegen.content + "\n" + extraGenerated
   );
   const skdFilePath = path.join(bgsdkDirectoryPath, "sdk.ts");
   if (!fs.existsSync(skdFilePath)) {
     fs.writeFileSync(skdFilePath, sdkFileContents);
   }
 
-  const gitignorePath = path.join(process.cwd(), ".gitignore");
-  if (fs.existsSync(gitignorePath)) {
-    const gitignore = fs.readFileSync(gitignorePath, "utf8");
-    if (!gitignore.includes("generated")) {
-      fs.appendFileSync(gitignorePath, "\ngenerated/");
-      console.log('Added "generated/" to .gitignore');
-    }
-  }
-
   console.log("Done ✨");
 }
 
@@ -82,15 +73,15 @@ function createDirIfDoesNotExist(p: string) {
   }
 }
 
-const sdkFileContents = `import { GraphQLClient } from 'graphql-request'
-import { getSdk } from './generated'
-
-export type CreateBGsdkClientParams = {
+const extraGenerated = `export type CreateBgSdkParams = {
   endpoint: string
   headers?: string[][] | Record<string, string> | Headers
 }
 
-export const createBGsdk = ({ endpoint, headers }: CreateBGsdkClientParams) => {
+export const createBgSdk = ({
+  endpoint,
+  headers
+}: CreateBgSdkParams) => {
   const graphQLClient = new GraphQLClient(endpoint, {
     headers: {
       accept: 'application/json',
@@ -101,11 +92,13 @@ export const createBGsdk = ({ endpoint, headers }: CreateBGsdkClientParams) => {
 
   const generatedSdk = getSdk(graphQLClient)
 
-  return { ...generatedSdk, rawClient: graphQLClient }
+  return { ...generatedSdk, client: graphQLClient }
 }
+`;
+
+const sdkFileContents = `import config from './config'
+import { createBgSdk } from './generated'
 
-// You can then create the sdk with the endpoint and headers set up and export it.
-// For example like this:
-// export const bgsdk = createBGsdk({ })
+export const bgSdk = createBgSdk(config)
 
 `;

package/src/util/get-b-gsdk-config.ts

@@ -3,18 +3,24 @@ import path from "path";
 import { z } from "zod";
 
 const configSchema = z.object({
-  schemaURL: z.string(),
-  headers: z.record(z.string()),
+  endpoint: z.string(),
+  headers: z.record(z.string()).optional(),
 });
 
+export type BGsdkConfig = z.infer<typeof configSchema>;
+
 export const getBGsdkConfig = (directoryPath: string) => {
-  const bgsdkConfigPath = path.join(directoryPath, "config.json");
-  if (!fs.existsSync(bgsdkConfigPath)) {
-    throw new Error(
-      `Could not find config.json in ${directoryPath}! Please create one.`
-    );
+  const bgsdkConfigJsonPath = path.join(directoryPath, "config.json");
+  const bgsdkConfigJSPath = path.join(directoryPath, "config.js");
+
+  let rawConfig = {};
+  if (fs.existsSync(bgsdkConfigJsonPath)) {
+    rawConfig = JSON.parse(fs.readFileSync(bgsdkConfigJsonPath, "utf8"));
+  } else if (fs.existsSync(bgsdkConfigJSPath)) {
+    rawConfig = require(bgsdkConfigJSPath);
+  } else {
+    throw new Error(`Could not find config.{json,js} in ${directoryPath}`);
   }
-  const rawConfig = JSON.parse(fs.readFileSync(bgsdkConfigPath, "utf8"));
   const parsedConfig = configSchema.parse(rawConfig);
   return parsedConfig;
 };

package/dist/bin.js

@@ -1,39 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require(".");
-const format_error_1 = require("./util/format-error");
-const arg_1 = __importDefault(require("arg"));
-// Show usage and exit with code
-function help(code) {
-    console.log(`Usage:
-  
-  b-gsdk generate
-  
-  `);
-    process.exit(code);
-}
-// Get CLI arguments
-const [, , cmd] = process.argv;
-const args = (0, arg_1.default)({
-    // types
-    "--dir": String,
-    // aliases
-    "-d": "--dir",
-}, { permissive: true });
-// CLI commands
-const cmds = {
-    generate: _1.main,
-};
-// Run CLI
-try {
-    // Run command or show usage for unknown command
-    cmds[cmd] ? cmds[cmd](args) : help(0);
-}
-catch (e) {
-    console.error((0, format_error_1.formatError)(e).message);
-    process.exit(1);
-}

package/dist/util/format-error.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatError = void 0;
-const formatError = (error) => {
-    if (error instanceof Error) {
-        return error;
-    }
-    if (typeof error === "string") {
-        return new Error(error);
-    }
-    if (typeof error === "object") {
-        return new Error(JSON.stringify(error, null, 2));
-    }
-    return new Error(`Unknown error: ${error}`);
-};
-exports.formatError = formatError;

package/dist/util/get-b-gsdk-config.js

@@ -1,23 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBGsdkConfig = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const zod_1 = require("zod");
-const configSchema = zod_1.z.object({
-    schemaURL: zod_1.z.string(),
-    headers: zod_1.z.record(zod_1.z.string()),
-});
-const getBGsdkConfig = (directoryPath) => {
-    const bgsdkConfigPath = path_1.default.join(directoryPath, "config.json");
-    if (!fs_1.default.existsSync(bgsdkConfigPath)) {
-        throw new Error(`Could not find config.json in ${directoryPath}! Please create one.`);
-    }
-    const rawConfig = JSON.parse(fs_1.default.readFileSync(bgsdkConfigPath, "utf8"));
-    const parsedConfig = configSchema.parse(rawConfig);
-    return parsedConfig;
-};
-exports.getBGsdkConfig = getBGsdkConfig;

package/dist/util/get-b-gsdk-directory-path.js

@@ -1,16 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBGsdkDirectoryPath = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const getBGsdkDirectoryPath = (cwd, customDir) => {
-    const schemaPath = path_1.default.join(cwd, customDir || "b-gsdk");
-    if (fs_1.default.existsSync(schemaPath)) {
-        return schemaPath;
-    }
-    return null;
-};
-exports.getBGsdkDirectoryPath = getBGsdkDirectoryPath;

package/src/docs/fragments/product.gql

@@ -1,10 +0,0 @@
-fragment Cart on Cart {
-  id
-  checkoutUrl
-}
-
-query FetchCart($id: ID!) {
-  cart(id: $id) {
-    ...Cart
-  }
-}