@gambalabs/apollo 6.0.0-alpha.17 → 6.0.0-alpha.20

package/dist/shared/apollo.d410709a.d.ts

@@ -0,0 +1,202 @@
+import { ClientOptions } from 'graphql-ws';
+import { HttpOptions, DefaultOptions, InMemoryCacheConfig } from '@apollo/client';
+import { CookieOptions } from 'nuxt/app';
+
+type CookieAttributes = Omit< CookieOptions, 'encode' | 'decode' | 'expires' | 'default'>;
+
+type Pusher = {
+  cluster: string;
+  wsHost: string;
+  wsPort: number;
+  forceTLS: boolean;
+  channelEndpoint: string;
+  pusherAppKey: string;
+  activityTimeout: number;
+}
+
+type ClientConfig = {
+  /**
+   * The GraphQL endpoint.
+   * @type {string}
+   */
+  httpEndpoint: string;
+
+  /**
+   * Provide a GraphQL endpoint to be used client-side. Overrides `httpEndpoint`.
+   * @type {string}
+   **/
+  browserHttpEndpoint?: string;
+
+  /**
+   * Provide additional configuration for the `HttpLink`.
+   * See https://www.apollographql.com/docs/link/links/http.html#options
+   * @type {HttpOptions}
+   **/
+  httpLinkOptions?: Omit<HttpOptions, 'uri'>;
+
+  /**
+   * Provide additional configuration for the `GraphQLWsLink`.
+   * See https://github.com/enisdenjo/graphql-ws/blob/master/docs/interfaces/client.ClientOptions.md
+   **/
+  wsLinkOptions?: Omit<ClientOptions, 'url' | 'connectionParams'>;
+
+  /**
+   * Specify a websocket endpoint to be used for subscriptions.
+   * The `wss` protocol is recommended in production.
+   * @type {string}
+   **/
+  wsEndpoint?: string;
+
+  /**
+   * Specify if the client should solely use WebSocket.
+   * requires `wsEndpoint`.
+   * @type {boolean}
+   * @default false
+   **/
+  websocketsOnly?: boolean;
+
+  /**
+   * Specify a pusher config to be used for subscriptions.
+   * @type {Pusher}
+   **/
+  pusher?: Pusher
+
+  /**
+   * Specify if the client should be able to connect to the Apollo Client Devtools in production mode.
+   * @type {boolean}
+   * @default false
+   **/
+  connectToDevTools?: boolean;
+
+  /**
+   * Configure default options to be applied to the apollo client.
+   **/
+  defaultOptions?: DefaultOptions;
+
+  /**
+   * Configure the in-memory cache.
+   **/
+  inMemoryCacheOptions?: InMemoryCacheConfig;
+
+  /**
+   * Specify the name under which the token will be stored.
+   * as in either a cookie or localStorage.
+   * @type {string}
+   * @default "apollo:<client-name>.token"
+   */
+  tokenName?: string;
+
+  /**
+   * Specify if the auth token should be stored in `cookie` or `localStorage`.
+   * `Cookie` storage is required for SSR.
+   * @type {string}
+   * @default "cookie"
+   **/
+  tokenStorage?: 'cookie' | 'localStorage';
+
+  /**
+   * Specify the Authentication scheme.
+   * @type {string}
+   * @default "Bearer"
+   **/
+  authType?: string | null;
+
+  /**
+   * Name of the Authentication token header.
+   * @type {string}
+   * @default "Authorization"
+   */
+  authHeader?: string;
+
+  /**
+   * Configuration for the auth cookie.
+   **/
+  cookieAttributes?: CookieAttributes;
+
+  /**
+   * Name of the CSRF token header.
+   * @type {string}
+   * @default "X-CSRF-TOKEN"
+   */
+  csrfHeader?: string
+
+  /**
+   * Enable automatic persisted queries.
+   * @type {boolean}
+   * @default false
+   */
+  persistedQueries?: boolean
+};
+
+interface NuxtApolloConfig<T = false> {
+  /**
+   * Determine if vue-apollo composables should be automatically imported.
+   * @type {boolean}
+   * @default true
+   **/
+  autoImports?: boolean;
+
+  /**
+   * Configuration of the Apollo clients.
+   **/
+  clients?: Record< string, T extends false ? string | ClientConfig : ClientConfig >;
+
+  /**
+   * Default options to be applied to all Apollo clients.
+   * This is useful for setting global defaults, and is overridden by `defaultOptions` passed directly to clients.
+   **/
+  defaultOptions?: DefaultOptions;
+
+  /**
+   * Pass cookies from the browser to the GraphQL API in SSR mode.
+   *
+   * @type boolean
+   * @default true
+   * */
+  proxyCookies?: boolean;
+
+  /**
+   * Specify the Authentication scheme.
+   * @type {string}
+   * @default 'Bearer'
+   **/
+  authType?: string;
+
+  /**
+   * Name of the Authentication token header.
+   * @type {string}
+   * @default "Authorization"
+   */
+  authHeader?: string;
+
+  /**
+   * Name of the CSRF token header.
+   * @type {string}
+   * @default "X-CSRF-TOKEN"
+   */
+  csrfHeader?: string;
+
+  /**
+   * Specify if the auth token should be stored in `cookie` or `localStorage`.
+   * `Cookie` storage is required for SSR.
+   * @type {string}
+   * @default "cookie"
+   **/
+  tokenStorage?: 'cookie' | 'localStorage';
+
+  /**
+   * Configuration for the auth cookie.
+   **/
+  cookieAttributes?: CookieAttributes;
+
+  /**
+   * Apollo client awareness instructs the client to send two additional headers
+   * `apollographql-client-name` and `apollographql-client-version` in each HTTP request.
+   * This behavior is disabled by default.
+   * @type {boolean}
+   * @default false
+   */
+  clientAwareness?: boolean
+}
+
+export type { ClientConfig as C, NuxtApolloConfig as N };

package/dist/types.d.mts

@@ -0,0 +1,20 @@
+
+import type { ModuleOptions, ModuleRuntimeConfig, ModulePublicRuntimeConfig } from './module.js'
+
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['apollo']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['apollo']?: ModuleOptions }
+  interface RuntimeConfig extends ModuleRuntimeConfig {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['apollo']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['apollo']?: ModuleOptions }
+  interface RuntimeConfig extends ModuleRuntimeConfig {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
+}
+
+
+export type { ErrorResponse } from './module.js'

package/dist/types.d.ts

@@ -1,10 +1,20 @@
 
-import { ModuleOptions } from './module'
+import type { ModuleOptions, ModuleRuntimeConfig, ModulePublicRuntimeConfig } from './module'
+
 
 declare module '@nuxt/schema' {
   interface NuxtConfig { ['apollo']?: Partial<ModuleOptions> }
   interface NuxtOptions { ['apollo']?: ModuleOptions }
+  interface RuntimeConfig extends ModuleRuntimeConfig {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['apollo']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['apollo']?: ModuleOptions }
+  interface RuntimeConfig extends ModuleRuntimeConfig {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
 }
 
 
-export { ErrorResponse } from './module'
+export type { ErrorResponse } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gambalabs/apollo",
-  "version": "6.0.0-alpha.17",
+  "version": "6.0.0-alpha.20",
   "license": "MIT",
   "repository": "https://github.com/GambaLabs/apollo",
   "homepage": "https://apollo.nuxtjs.org",
@@ -9,6 +9,10 @@
     ".": {
       "types": "./dist/types.d.ts",
       "import": "./dist/module.mjs"
+    },
+    "./config": {
+      "types": "./dist/config.d.ts",
+      "import": "./dist/config.mjs"
     }
   },
   "main": "./dist/module.mjs",
@@ -17,29 +21,30 @@
     "dist"
   ],
   "dependencies": {
-    "@apollo/client": "^3.8.7",
-    "@nuxt/kit": "^3.8.2",
+    "@apollo/client": "^3.9.5",
+    "@nuxt/kit": "^3.10.3",
     "@rollup/plugin-graphql": "^2.0.4",
-    "@vue/apollo-composable": "4.0.0-beta.4",
+    "@vue/apollo-composable": "^4.0.1",
     "apollo-upload-client": "^18.0.1",
     "crypto-hash": "^2.0.1",
-    "defu": "^6.1.3",
-    "destr": "^1.2.2",
+    "@vue/apollo-option": "^4.0.0",
+    "defu": "^6.1.4",
+    "destr": "^2.0.3",
     "graphql": "^16.8.1",
     "graphql-tag": "^2.12.6",
-    "graphql-ws": "^5.14.2",
+    "graphql-ws": "^5.15.0",
     "jiti": "^1.21.0",
     "ohash": "^1.1.3",
     "pusher-js": "^8.3.0"
   },
   "devDependencies": {
-    "@nuxt/module-builder": "^0.2.1",
-    "@nuxt/schema": "^3.8.2",
-    "@nuxt/ui": "^0.4.1",
+    "@nuxt/module-builder": "^0.5.5",
+    "@nuxt/schema": "^3.10.3",
+    "@nuxt/ui": "^2.14.1",
     "@nuxtjs/eslint-config-typescript": "^12.1.0",
-    "@types/node": "^18.18.13",
-    "eslint": "^8.54.0",
-    "nuxt": "^3.8.2"
+    "@types/node": "^20.11.24",
+    "eslint": "^8.57.0",
+    "nuxt": "^3.10.3"
   },
   "publishConfig": {
     "access": "public"
@@ -47,12 +52,14 @@
   "resolutions": {
     "@nuxtjs/apollo": "link:."
   },
-  "packageManager": "pnpm@7.29.1",
+  "packageManager": "pnpm@8.15.2",
   "scripts": {
-    "build": "nuxt-module-build",
+    "build": "nuxt-module-build build",
     "dev": "nuxi dev playground --dotenv .env --host",
     "dev:build": "nuxi build playground",
-    "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxi prepare playground",
+    "lint": "eslint --ext .js,.ts,.vue --ignore-path .gitignore .",
+    "lint:fix": "eslint --fix --ext .js,.ts,.vue --ignore-path .gitignore .",
     "release": "standard-version --prerelease alpha && git push --follow-tags && pnpm publish --tag next"
   }
 }