@geins/core 0.3.4-canary → 0.3.5-canary

package/.turbo/turbo-build.log

@@ -2,5 +2,5 @@ yarn run v1.22.22
 $ rollup -c
 
 src/index.ts → dist/index.cjs, dist/index.esm.js...
-created dist/index.cjs, dist/index.esm.js in 6.1s
-Done in 6.66s.
+created dist/index.cjs, dist/index.esm.js in 6.3s
+Done in 6.89s.

package/CHANGELOG.md

@@ -1,12 +1,20 @@
 # @geins/core
 
-## 0.3.4-canary
+## 0.3.5-canary
 
 ### Patch Changes
 
 - d666708: added settingvars to GraphQLService
+- 2158dcd: Possiblity to use string as query for the merchantAPI
 - 5f86eeb: ci fixes
 
+## 0.3.4
+
+### Patch Changes
+
+- 3cf633e: added settingvars to GraphQLService
+- 3cf633e: ci fixes
+
 ## 0.3.3
 
 ### Patch Changes

package/__tests__/Graphql.test.ts

@@ -40,4 +40,30 @@ describe('GeinsCMS', () => {
     expect(result!.channels).toBeDefined();
     expect(result!.channels.length).toBeGreaterThan(0);
   });
+
+  it('should get result from custom string query', async () => {
+    const MY_QUERY = `
+      query getChannels {
+        channels {
+          name
+          url
+        }
+      }
+    `;
+
+    interface Channels {
+      channels: {
+        name: string;
+        url: string;
+      }[];
+    }
+
+    const result = await graphqlClient.query<Channels>({
+      queryAsString: MY_QUERY,
+    });
+
+    expect(result).toBeDefined();
+    expect(result!.channels).toBeDefined();
+    expect(result!.channels.length).toBeGreaterThan(0);
+  });
 });

package/dist/api-client/merchantApiClient.d.ts

@@ -1,4 +1,4 @@
-import { ApolloClient, NormalizedCacheObject, FetchPolicy, ApolloQueryResult, FetchResult, OperationVariables } from '@apollo/client/core';
+import { ApolloClient, NormalizedCacheObject, DocumentNode, FetchPolicy, ApolloQueryResult, FetchResult, OperationVariables } from '@apollo/client/core';
 export declare enum FetchPolicyOptions {
     CACHE_FIRST = "cache-first",
     NETWORK_ONLY = "network-only",
@@ -23,7 +23,8 @@ export interface MerchantApiClientOptions {
     userToken?: string;
 }
 export interface GraphQLQueryOptions {
-    query?: any;
+    query?: DocumentNode | string | undefined;
+    queryAsString?: string | undefined;
     variables?: any;
     requestOptions?: RequestOptions;
 }

package/dist/index.cjs

@@ -16162,15 +16162,18 @@ var MerchantApiClient = /** @class */ (function () {
         }
         return exports.FetchPolicyOptions.NETWORK_ONLY;
     };
-    MerchantApiClient.prototype.getOperationObject = function (operationType, document, variables, options) {
+    MerchantApiClient.prototype.getOperationObject = function (operationType, operationOptions) {
         var _a;
         var _b;
-        if (variables === void 0) { variables = {}; }
-        if (options === void 0) { options = {}; }
+        var query = operationOptions.query, queryAsString = operationOptions.queryAsString, variables = operationOptions.variables, requestOptions = operationOptions.requestOptions;
+        var queryDocument = query || gql(queryAsString || '');
+        var options = requestOptions || {};
         var token = this._userToken || ((_b = this._cookieService) === null || _b === void 0 ? void 0 : _b.get(AUTH_COOKIES.USER_AUTH));
-        // remove typename from variables
+        if (!queryDocument) {
+            throw new Error('Query is required');
+        }
         var operationObj = (_a = {},
-            _a[operationType] = document,
+            _a[operationType] = queryDocument,
             _a.variables = variables,
             _a.fetchPolicy = this.getFetchPolicy(operationType, options.fetchPolicy),
             _a.pollInterval = options.pollInterval || this.pollInterval,
@@ -16186,20 +16189,18 @@ var MerchantApiClient = /** @class */ (function () {
     };
     MerchantApiClient.prototype.runQuery = function (options) {
         return __awaiter(this, void 0, void 0, function () {
-            var query, variables, requestOptions, q;
+            var q;
             return __generator(this, function (_a) {
-                query = options.query, variables = options.variables, requestOptions = options.requestOptions;
-                q = this.getOperationObject(exports.OperationType.QUERY, query, variables, requestOptions);
+                q = this.getOperationObject(exports.OperationType.QUERY, options);
                 return [2 /*return*/, this._apolloClient.query(q)];
             });
         });
     };
     MerchantApiClient.prototype.runMutation = function (options) {
         return __awaiter(this, void 0, void 0, function () {
-            var query, variables, requestOptions, q;
+            var q;
             return __generator(this, function (_a) {
-                query = options.query, variables = options.variables, requestOptions = options.requestOptions;
-                q = this.getOperationObject(exports.OperationType.MUTATION, query, variables, requestOptions);
+                q = this.getOperationObject(exports.OperationType.MUTATION, options);
                 return [2 /*return*/, this._apolloClient.mutate(q)];
             });
         });
@@ -21373,37 +21374,45 @@ var ChannelService = /** @class */ (function (_super) {
     return ChannelService;
 }(BaseApiService));
 
+/**
+ * GraphQLService class provides methods to interact with a GraphQL API.
+ * It extends the BaseApiService and includes methods for querying and mutating data.
+ */
 var GraphQLService = /** @class */ (function (_super) {
     __extends(GraphQLService, _super);
     function GraphQLService(client, geinsSettings) {
         return _super.call(this, client, geinsSettings) || this;
     }
     GraphQLService.prototype.verifyQueryOptions = function (options) {
-        var _a, _b, _c, _d;
-        if (!options.query) {
-            throw new Error('Query is required');
-        }
-        if (!(((_d = (_c = (_b = (_a = options.query) === null || _a === void 0 ? void 0 : _a.definitions) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.variableDefinitions) === null || _d === void 0 ? void 0 : _d.length) > 0)) {
-            console.log('NO VARS');
-            return options;
-        }
-        var queryOptions = __assign({}, options);
+        var _a, _b, _c, _d, _e;
+        var returnOptions = __assign({}, options);
+        if (!options.query && !options.queryAsString) {
+            throw new Error('Query or queryAsString is required');
+        }
+        // check if query is a string and convert it to a gql object
+        typeof returnOptions.query === 'string' && (returnOptions.query = gql(options.queryAsString || ''));
+        var definition = (_b = (_a = returnOptions.query) === null || _a === void 0 ? void 0 : _a.definitions) === null || _b === void 0 ? void 0 : _b[0];
+        if (!definition ||
+            definition.kind !== 'OperationDefinition' ||
+            !(((_d = (_c = definition.variableDefinitions) === null || _c === void 0 ? void 0 : _c.length) !== null && _d !== void 0 ? _d : 0) > 0)) {
+            return returnOptions;
+        }
+        var queryOptions = __assign({}, returnOptions);
+        var queryDocument = queryOptions.query;
         queryOptions.variables = this.createVariables(queryOptions.variables);
-        var queryVars = queryOptions.query.definitions[0].variableDefinitions.map(function (v) { return v.variable.name.value; });
+        var queryVars = ((_e = queryDocument.definitions[0].variableDefinitions) === null || _e === void 0 ? void 0 : _e.map(function (v) { return v.variable.name.value; })) || [];
         var providedVars = Object.keys(queryOptions.variables);
         providedVars.forEach(function (v) {
-            if (!queryVars.includes(v)) {
+            if (queryVars && !queryVars.includes(v)) {
                 delete queryOptions.variables[v];
             }
         });
         return queryOptions;
     };
     /**
-     * Generic method to run any GraphQL query
-     * @param query - The GraphQL query DocumentNode or gql query object
-     * @param variables - Variables to pass to the query
-     * @param options - Optional options like fetchPolicy, pollInterval, etc.
-     * @returns The result data of the query or null
+     * Executes a GraphQL query with the provided options.
+     * @param options - The options for the GraphQL query.
+     * @returns A promise that resolves to the query result or null if an error occurs.
      */
     GraphQLService.prototype.query = function (options) {
         return __awaiter(this, void 0, void 0, function () {
@@ -21425,17 +21434,15 @@ var GraphQLService = /** @class */ (function (_super) {
                         error_1 = _b.sent();
                         console.error('Query error:', error_1);
                         return [2 /*return*/, null];
-                    case 4: return [2 /*return*/, null];
+                    case 4: return [2 /*return*/];
                 }
             });
         });
     };
     /**
-     * Generic method to run any GraphQL mutation
-     * @param mutation - The GraphQL mutation DocumentNode or gql mutation object
-     * @param variables - Variables to pass to the mutation
-     * @param options - Optional options like fetchPolicy, etc.
-     * @returns The result data of the mutation or null
+     * Executes a GraphQL mutation with the provided options.
+     * @param options - The options for the GraphQL mutation.
+     * @returns A promise that resolves to the mutation result or null if an error occurs.
      */
     GraphQLService.prototype.mutation = function (options) {
         return __awaiter(this, void 0, void 0, function () {

package/dist/index.esm.js

@@ -16160,15 +16160,18 @@ var MerchantApiClient = /** @class */ (function () {
         }
         return FetchPolicyOptions.NETWORK_ONLY;
     };
-    MerchantApiClient.prototype.getOperationObject = function (operationType, document, variables, options) {
+    MerchantApiClient.prototype.getOperationObject = function (operationType, operationOptions) {
         var _a;
         var _b;
-        if (variables === void 0) { variables = {}; }
-        if (options === void 0) { options = {}; }
+        var query = operationOptions.query, queryAsString = operationOptions.queryAsString, variables = operationOptions.variables, requestOptions = operationOptions.requestOptions;
+        var queryDocument = query || gql(queryAsString || '');
+        var options = requestOptions || {};
         var token = this._userToken || ((_b = this._cookieService) === null || _b === void 0 ? void 0 : _b.get(AUTH_COOKIES.USER_AUTH));
-        // remove typename from variables
+        if (!queryDocument) {
+            throw new Error('Query is required');
+        }
         var operationObj = (_a = {},
-            _a[operationType] = document,
+            _a[operationType] = queryDocument,
             _a.variables = variables,
             _a.fetchPolicy = this.getFetchPolicy(operationType, options.fetchPolicy),
             _a.pollInterval = options.pollInterval || this.pollInterval,
@@ -16184,20 +16187,18 @@ var MerchantApiClient = /** @class */ (function () {
     };
     MerchantApiClient.prototype.runQuery = function (options) {
         return __awaiter(this, void 0, void 0, function () {
-            var query, variables, requestOptions, q;
+            var q;
             return __generator(this, function (_a) {
-                query = options.query, variables = options.variables, requestOptions = options.requestOptions;
-                q = this.getOperationObject(OperationType.QUERY, query, variables, requestOptions);
+                q = this.getOperationObject(OperationType.QUERY, options);
                 return [2 /*return*/, this._apolloClient.query(q)];
             });
         });
     };
     MerchantApiClient.prototype.runMutation = function (options) {
         return __awaiter(this, void 0, void 0, function () {
-            var query, variables, requestOptions, q;
+            var q;
             return __generator(this, function (_a) {
-                query = options.query, variables = options.variables, requestOptions = options.requestOptions;
-                q = this.getOperationObject(OperationType.MUTATION, query, variables, requestOptions);
+                q = this.getOperationObject(OperationType.MUTATION, options);
                 return [2 /*return*/, this._apolloClient.mutate(q)];
             });
         });
@@ -21371,37 +21372,45 @@ var ChannelService = /** @class */ (function (_super) {
     return ChannelService;
 }(BaseApiService));
 
+/**
+ * GraphQLService class provides methods to interact with a GraphQL API.
+ * It extends the BaseApiService and includes methods for querying and mutating data.
+ */
 var GraphQLService = /** @class */ (function (_super) {
     __extends(GraphQLService, _super);
     function GraphQLService(client, geinsSettings) {
         return _super.call(this, client, geinsSettings) || this;
     }
     GraphQLService.prototype.verifyQueryOptions = function (options) {
-        var _a, _b, _c, _d;
-        if (!options.query) {
-            throw new Error('Query is required');
-        }
-        if (!(((_d = (_c = (_b = (_a = options.query) === null || _a === void 0 ? void 0 : _a.definitions) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.variableDefinitions) === null || _d === void 0 ? void 0 : _d.length) > 0)) {
-            console.log('NO VARS');
-            return options;
-        }
-        var queryOptions = __assign({}, options);
+        var _a, _b, _c, _d, _e;
+        var returnOptions = __assign({}, options);
+        if (!options.query && !options.queryAsString) {
+            throw new Error('Query or queryAsString is required');
+        }
+        // check if query is a string and convert it to a gql object
+        typeof returnOptions.query === 'string' && (returnOptions.query = gql(options.queryAsString || ''));
+        var definition = (_b = (_a = returnOptions.query) === null || _a === void 0 ? void 0 : _a.definitions) === null || _b === void 0 ? void 0 : _b[0];
+        if (!definition ||
+            definition.kind !== 'OperationDefinition' ||
+            !(((_d = (_c = definition.variableDefinitions) === null || _c === void 0 ? void 0 : _c.length) !== null && _d !== void 0 ? _d : 0) > 0)) {
+            return returnOptions;
+        }
+        var queryOptions = __assign({}, returnOptions);
+        var queryDocument = queryOptions.query;
         queryOptions.variables = this.createVariables(queryOptions.variables);
-        var queryVars = queryOptions.query.definitions[0].variableDefinitions.map(function (v) { return v.variable.name.value; });
+        var queryVars = ((_e = queryDocument.definitions[0].variableDefinitions) === null || _e === void 0 ? void 0 : _e.map(function (v) { return v.variable.name.value; })) || [];
         var providedVars = Object.keys(queryOptions.variables);
         providedVars.forEach(function (v) {
-            if (!queryVars.includes(v)) {
+            if (queryVars && !queryVars.includes(v)) {
                 delete queryOptions.variables[v];
             }
         });
         return queryOptions;
     };
     /**
-     * Generic method to run any GraphQL query
-     * @param query - The GraphQL query DocumentNode or gql query object
-     * @param variables - Variables to pass to the query
-     * @param options - Optional options like fetchPolicy, pollInterval, etc.
-     * @returns The result data of the query or null
+     * Executes a GraphQL query with the provided options.
+     * @param options - The options for the GraphQL query.
+     * @returns A promise that resolves to the query result or null if an error occurs.
      */
     GraphQLService.prototype.query = function (options) {
         return __awaiter(this, void 0, void 0, function () {
@@ -21423,17 +21432,15 @@ var GraphQLService = /** @class */ (function (_super) {
                         error_1 = _b.sent();
                         console.error('Query error:', error_1);
                         return [2 /*return*/, null];
-                    case 4: return [2 /*return*/, null];
+                    case 4: return [2 /*return*/];
                 }
             });
         });
     };
     /**
-     * Generic method to run any GraphQL mutation
-     * @param mutation - The GraphQL mutation DocumentNode or gql mutation object
-     * @param variables - Variables to pass to the mutation
-     * @param options - Optional options like fetchPolicy, etc.
-     * @returns The result data of the mutation or null
+     * Executes a GraphQL mutation with the provided options.
+     * @param options - The options for the GraphQL mutation.
+     * @returns A promise that resolves to the mutation result or null if an error occurs.
      */
     GraphQLService.prototype.mutation = function (options) {
         return __awaiter(this, void 0, void 0, function () {

package/dist/services/graphQLService.d.ts

@@ -1,23 +1,23 @@
 import type { GeinsSettings } from '@geins/types';
 import { BaseApiService } from '../base/baseApiService';
 import { GraphQLQueryOptions } from '../api-client/merchantApiClient';
+/**
+ * GraphQLService class provides methods to interact with a GraphQL API.
+ * It extends the BaseApiService and includes methods for querying and mutating data.
+ */
 export declare class GraphQLService extends BaseApiService {
     constructor(client: any, geinsSettings: GeinsSettings);
     protected verifyQueryOptions(options: GraphQLQueryOptions): GraphQLQueryOptions;
     /**
-     * Generic method to run any GraphQL query
-     * @param query - The GraphQL query DocumentNode or gql query object
-     * @param variables - Variables to pass to the query
-     * @param options - Optional options like fetchPolicy, pollInterval, etc.
-     * @returns The result data of the query or null
+     * Executes a GraphQL query with the provided options.
+     * @param options - The options for the GraphQL query.
+     * @returns A promise that resolves to the query result or null if an error occurs.
      */
     query<T = any>(options: GraphQLQueryOptions): Promise<T | null>;
     /**
-     * Generic method to run any GraphQL mutation
-     * @param mutation - The GraphQL mutation DocumentNode or gql mutation object
-     * @param variables - Variables to pass to the mutation
-     * @param options - Optional options like fetchPolicy, etc.
-     * @returns The result data of the mutation or null
+     * Executes a GraphQL mutation with the provided options.
+     * @param options - The options for the GraphQL mutation.
+     * @returns A promise that resolves to the mutation result or null if an error occurs.
      */
     mutation<T = any>(options: GraphQLQueryOptions): Promise<T | null>;
     protected parseResult(result: any): any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geins/core",
-  "version": "0.3.4-canary",
+  "version": "0.3.5-canary",
   "main": "dist/index.cjs",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
@@ -20,8 +20,8 @@
     "broadcast-channel": "^7.0.0"
   },
   "devDependencies": {
-    "@geins/types": "0.3.4-canary",
-    "@geins/eslint-config": "0.1.5-canary",
+    "@geins/types": "0.3.5-canary",
+    "@geins/eslint-config": "0.1.6-canary",
     "@rollup/plugin-commonjs": "^28.0.0",
     "@rollup/plugin-graphql": "^2.0.5",
     "@rollup/plugin-node-resolve": "^15.3.0",

package/src/api-client/merchantApiClient.ts

@@ -10,6 +10,7 @@ import {
   FetchResult,
   OperationVariables,
 } from '@apollo/client/core';
+import { gql } from '@apollo/client/core';
 
 export enum FetchPolicyOptions {
   CACHE_FIRST = 'cache-first',
@@ -39,7 +40,8 @@ export interface MerchantApiClientOptions {
 }
 
 export interface GraphQLQueryOptions {
-  query?: any;
+  query?: DocumentNode | string | undefined;
+  queryAsString?: string | undefined;
   variables?: any;
   requestOptions?: RequestOptions;
 }
@@ -108,17 +110,18 @@ export class MerchantApiClient {
     return FetchPolicyOptions.NETWORK_ONLY;
   }
 
-  private getOperationObject(
-    operationType: OperationType,
-    document: DocumentNode,
-    variables: OperationVariables = {},
-    options: RequestOptions = {},
-  ) {
+  private getOperationObject(operationType: OperationType, operationOptions: GraphQLQueryOptions) {
+    const { query, queryAsString, variables, requestOptions } = operationOptions;
+    const queryDocument = query || gql(queryAsString || '');
+    const options = requestOptions || {};
     const token = this._userToken || this._cookieService?.get(AUTH_COOKIES.USER_AUTH);
-    // remove typename from variables
+
+    if (!queryDocument) {
+      throw new Error('Query is required');
+    }
 
     const operationObj: any = {
-      [operationType]: document,
+      [operationType]: queryDocument,
       variables,
       fetchPolicy: this.getFetchPolicy(operationType, options.fetchPolicy),
       pollInterval: options.pollInterval || this.pollInterval,
@@ -138,16 +141,14 @@ export class MerchantApiClient {
   async runQuery<TData = any, TVariables extends OperationVariables = OperationVariables>(
     options: GraphQLQueryOptions,
   ): Promise<ApolloQueryResult<TData>> {
-    const { query, variables, requestOptions } = options;
-    const q = this.getOperationObject(OperationType.QUERY, query, variables, requestOptions);
+    const q = this.getOperationObject(OperationType.QUERY, options);
     return this._apolloClient.query<TData, TVariables>(q);
   }
 
   async runMutation<TData = any, TVariables extends OperationVariables = OperationVariables>(
     options: GraphQLQueryOptions,
   ): Promise<FetchResult<TData>> {
-    const { query, variables, requestOptions } = options;
-    const q = this.getOperationObject(OperationType.MUTATION, query, variables, requestOptions);
+    const q = this.getOperationObject(OperationType.MUTATION, options);
     return this._apolloClient.mutate<TData, TVariables>(q);
   }
 }

package/src/services/graphQLService.ts

@@ -1,48 +1,59 @@
 import type { GeinsSettings } from '@geins/types';
 import { BaseApiService } from '../base/baseApiService';
 import { GraphQLQueryOptions } from '../api-client/merchantApiClient';
+import { DocumentNode, OperationDefinitionNode } from 'graphql';
+import { gql } from '@apollo/client/core';
 
+/**
+ * GraphQLService class provides methods to interact with a GraphQL API.
+ * It extends the BaseApiService and includes methods for querying and mutating data.
+ */
 export class GraphQLService extends BaseApiService {
   constructor(client: any, geinsSettings: GeinsSettings) {
     super(client, geinsSettings);
   }
   protected verifyQueryOptions(options: GraphQLQueryOptions): GraphQLQueryOptions {
-    if (!options.query) {
-      throw new Error('Query is required');
+    const returnOptions = { ...options };
+    if (!options.query && !options.queryAsString) {
+      throw new Error('Query or queryAsString is required');
     }
-    if (!(options.query?.definitions?.[0]?.variableDefinitions?.length > 0)) {
-      console.log('NO VARS');
-      return options;
+    // check if query is a string and convert it to a gql object
+    typeof returnOptions.query === 'string' && (returnOptions.query = gql(options.queryAsString || ''));
+
+    const definition = returnOptions.query?.definitions?.[0] as OperationDefinitionNode;
+    if (
+      !definition ||
+      definition.kind !== 'OperationDefinition' ||
+      !((definition.variableDefinitions?.length ?? 0) > 0)
+    ) {
+      return returnOptions;
     }
 
-    const queryOptions = { ...options };
+    const queryOptions = { ...returnOptions };
+    const queryDocument = queryOptions.query as DocumentNode;
     queryOptions.variables = this.createVariables(queryOptions.variables);
-
-    const queryVars = queryOptions.query.definitions[0].variableDefinitions.map(
-      (v: any) => v.variable.name.value,
-    );
+    const queryVars =
+      (queryDocument.definitions[0] as OperationDefinitionNode).variableDefinitions?.map(
+        (v: any) => v.variable.name.value,
+      ) || [];
 
     const providedVars = Object.keys(queryOptions.variables);
     providedVars.forEach(v => {
-      if (!queryVars.includes(v)) {
+      if (queryVars && !queryVars.includes(v)) {
         delete queryOptions.variables[v];
       }
     });
 
     return queryOptions;
   }
-
   /**
-   * Generic method to run any GraphQL query
-   * @param query - The GraphQL query DocumentNode or gql query object
-   * @param variables - Variables to pass to the query
-   * @param options - Optional options like fetchPolicy, pollInterval, etc.
-   * @returns The result data of the query or null
+   * Executes a GraphQL query with the provided options.
+   * @param options - The options for the GraphQL query.
+   * @returns A promise that resolves to the query result or null if an error occurs.
    */
   async query<T = any>(options: GraphQLQueryOptions): Promise<T | null> {
     try {
       const queryOptions = await this.verifyQueryOptions(options);
-
       const result = this.cleanObject(await this.runQuery(queryOptions));
       const parsedResult = this.parseResult(result);
       return parsedResult as T;
@@ -50,15 +61,12 @@ export class GraphQLService extends BaseApiService {
       console.error('Query error:', error);
       return null;
     }
-    return null;
   }
 
   /**
-   * Generic method to run any GraphQL mutation
-   * @param mutation - The GraphQL mutation DocumentNode or gql mutation object
-   * @param variables - Variables to pass to the mutation
-   * @param options - Optional options like fetchPolicy, etc.
-   * @returns The result data of the mutation or null
+   * Executes a GraphQL mutation with the provided options.
+   * @param options - The options for the GraphQL mutation.
+   * @returns A promise that resolves to the mutation result or null if an error occurs.
    */
   async mutation<T = any>(options: GraphQLQueryOptions): Promise<T | null> {
     try {