@teambit/graphql 0.0.554 → 0.0.555

package/dist/create-link.d.ts

@@ -1,3 +1,8 @@
 import { HttpLink } from '@apollo/client';
 import type { WebSocketLink } from '@apollo/client/link/ws';
+/**
+ * create a link which splits routes data depending on type of operation.
+ * @param httpLink http link for apollo graphql
+ * @param wsLink web socket link for apollo graphql
+ */
 export declare function createSplitLink(httpLink: HttpLink, wsLink: WebSocketLink): import("@apollo/client").ApolloLink;

package/dist/graphql-error.d.ts

@@ -1,5 +1,19 @@
 export declare class GraphQlError {
+    /**
+     * http status code of error
+     */
     readonly code: number;
+    /**
+     * error message of the error
+     */
     readonly message?: string | undefined;
-    constructor(code: number, message?: string | undefined);
+    constructor(
+    /**
+     * http status code of error
+     */
+    code: number, 
+    /**
+     * error message of the error
+     */
+    message?: string | undefined);
 }

package/dist/graphql.main.runtime.d.ts

@@ -26,20 +26,66 @@ export declare type GraphQLServerOptions = {
     onWsConnect?: Function;
 };
 export declare class GraphqlMain {
+    /**
+     * extension config
+     */
     readonly config: GraphQLConfig;
+    /**
+     * slot for registering graphql modules
+     */
     private moduleSlot;
+    /**
+     * harmony context.
+     */
     private context;
+    /**
+     * graphql pubsub. allows to emit events to clients.
+     */
     readonly pubsub: PubSub;
+    /**
+     * logger extension.
+     */
     readonly logger: Logger;
     private graphQLServerSlot;
-    constructor(config: GraphQLConfig, moduleSlot: SchemaSlot, context: Harmony, pubsub: PubSub, logger: Logger, graphQLServerSlot: GraphQLServerSlot);
+    constructor(
+    /**
+     * extension config
+     */
+    config: GraphQLConfig, 
+    /**
+     * slot for registering graphql modules
+     */
+    moduleSlot: SchemaSlot, 
+    /**
+     * harmony context.
+     */
+    context: Harmony, 
+    /**
+     * graphql pubsub. allows to emit events to clients.
+     */
+    pubsub: PubSub, 
+    /**
+     * logger extension.
+     */
+    logger: Logger, graphQLServerSlot: GraphQLServerSlot);
     private modules;
     createServer(options: GraphQLServerOptions): Promise<Server>;
+    /**
+     * register a new graphql server.
+     */
     registerServer(server: GraphQLServer): this;
+    /**
+     * start a graphql server.
+     */
     listen(port?: number, server?: Server, app?: Express): Promise<void>;
+    /**
+     * register a new graphql module.
+     */
     register(schema: Schema): this;
     private getPort;
+    /** create Subscription server with different port */
     private createSubscription;
+    /** proxy ws Subscription server to avoid conflict with different websocket connections */
     private proxySubscription;
     private createRootModule;
     private buildModules;

package/dist/graphql.ui.runtime.d.ts

@@ -2,9 +2,15 @@ import { ReactNode } from 'react';
 import { ApolloClient } from '@apollo/client';
 import type { NormalizedCacheObject } from '@apollo/client';
 import { GraphqlRenderLifecycle } from './render-lifecycle';
+/**
+ * Type of gql client.
+ * Used to abstract Apollo client, so consumers could import the type from graphql.ui, and not have to depend on @apollo/client directly
+ * */
 export declare type GraphQLClient<T> = ApolloClient<T>;
 declare type ClientOptions = {
+    /** Preset in-memory cache with state (e.g. continue state from SSR) */
     state?: NormalizedCacheObject;
+    /** endpoint for websocket connections */
     subscriptionUri?: string;
 };
 export declare class GraphqlUI {
@@ -15,6 +21,9 @@ export declare class GraphqlUI {
     }): ApolloClient<NormalizedCacheObject>;
     private createCache;
     private createLink;
+    /**
+     * get the graphQL provider
+     */
     getProvider: ({ client, children }: {
         client: GraphQLClient<any>;
         children: ReactNode;

package/dist/render-lifecycle.d.ts

@@ -16,6 +16,10 @@ export declare class GraphqlRenderLifecycle implements RenderLifecycle<RenderCon
             port: number;
         } | undefined;
     }) => RenderContext | undefined;
+    /**
+     * Eagerly and recursively execute all gql queries in the app.
+     * Data will be available in gqlClient.extract()
+     */
     onBeforeRender: (ctx: RenderContext, app: ReactNode) => Promise<void>;
     serialize: (ctx?: RenderContext | undefined) => {
         json: string;

package/dist/schema.d.ts

@@ -1,4 +1,7 @@
 import type { DocumentNode } from 'graphql';
+/**
+ * graphql schema for an extension.
+ */
 export declare type Schema = {
     typeDefs?: string | DocumentNode;
     resolvers?: {

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/graphql",
-  "version": "0.0.554",
+  "version": "0.0.555",
   "homepage": "https://bit.dev/teambit/harmony/graphql",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "graphql",
-    "version": "0.0.554"
+    "version": "0.0.555"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -32,12 +32,12 @@
     "bufferutil": "4.0.3",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/cli": "0.0.385",
-    "@teambit/logger": "0.0.470",
-    "@teambit/toolbox.network.get-port": "0.0.89",
-    "@teambit/preview": "0.0.554",
-    "@teambit/ui": "0.0.554",
-    "@teambit/ui-foundation.ui.is-browser": "0.0.462"
+    "@teambit/cli": "0.0.386",
+    "@teambit/logger": "0.0.471",
+    "@teambit/toolbox.network.get-port": "0.0.90",
+    "@teambit/preview": "0.0.555",
+    "@teambit/ui": "0.0.555",
+    "@teambit/ui-foundation.ui.is-browser": "0.0.463"
   },
   "devDependencies": {
     "@types/cors": "2.8.10",
@@ -54,7 +54,7 @@
   "peerDependencies": {
     "@apollo/client": "^3.0.0",
     "graphql": "14.7.0",
-    "@teambit/legacy": "1.0.171",
+    "@teambit/legacy": "1.0.172",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -84,7 +84,7 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.171",
+        "@teambit/legacy": "1.0.172",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }

package/tsconfig.json

@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },