Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 90 additions & 0 deletions types/apollo-upload-client/UploadHttpLink.d.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
import { ApolloLink } from "@apollo/client/link";
import { BaseHttpLink, selectURI } from "@apollo/client/link/http";

interface UploadHttpLinkOptions {
/**
* @param {Parameters<typeof selectURI>[1]} [options.uri] GraphQL endpoint
* URI. Defaults to `"/graphql"`.
*/
uri?: Parameters<typeof selectURI>[1];

/**
* @param {boolean} [options.useGETForQueries] Should GET be used to fetch
* queries, if there are no files to upload.
*/
useGETForQueries?: boolean;

/**
* @param {ExtractableFileMatcher} [options.isExtractableFile] Matches
* extractable files in the GraphQL operation. Defaults to
* {@linkcode isExtractableFile}.
*/
isExtractableFile?: ExtractableFileMatcher;

/**
* @param {typeof FormData} [options.FormData]
* `FormData` class. Defaults to the {@linkcode FormData} global.
*/
FormData?: typeof FormData;

/**
* @param {FormDataFileAppender} [options.formDataAppendFile]
* Customizes how extracted files are appended to the `FormData` instance.
* Defaults to {@linkcode formDataAppendFile}.
*/
formDataAppendFile?: FormDataFileAppender;

print?: BaseHttpLink.Printer;

/**
* @param {typeof fetch} [options.fetch]
* `fetch` implementation. Defaults to the {@linkcode fetch} global.
*/
fetch?: typeof fetch;

/**
* @param {RequestInit} [options.fetchOptions] `fetch` options; overridden by
* upload requirements.
*/
fetchOptions?: RequestInit;

/**
* @param {string} [options.credentials] Overrides
* {@linkcode RequestInit.credentials credentials} in {@linkcode fetchOptions}.
*/
credentials?: string;

/**
* @param {{ [headerName: string]: string }} [options.headers] Merges with and
* overrides {@linkcode RequestInit.headers headers} in {@linkcode fetchOptions}.
*/
headers?: { [headerName: string]: string };

/**
* @param {boolean} [options.includeExtensions] Toggles sending `extensions`
* fields to the GraphQL server. Defaults to `false`.
*/
includeExtensions?: boolean;

/**
* @param {boolean} [options.includeUnusedVariables] Toggles including unused
* GraphQL variables in the request. Defaults to `false`.
*/
includeUnusedVariables?: boolean;
}

export default class UploadHttpLink extends ApolloLink {
constructor(
options?: UploadHttpLinkOptions,
);
}

type ExtractableFileMatcher<ExtractableFile = any> = (value: unknown) => value is ExtractableFile;

type FormDataFileAppender<ExtractableFile = any> = (
formData: FormData,
fieldName: string,
file: ExtractableFile,
) => any;

export { ExtractableFileMatcher, FormDataFileAppender };
6 changes: 3 additions & 3 deletions types/apollo-upload-client/apollo-upload-client-tests.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import createUploadLink from "apollo-upload-client/createUploadLink.mjs";
import formDataAppendFile from "apollo-upload-client/formDataAppendFile.mjs";
import isExtractableFile from "apollo-upload-client/isExtractableFile.mjs";
import UploadHttpLink from "apollo-upload-client/UploadHttpLink.mjs";

// ==============================================================================
// createUploadLink
// UploadHttpLink
// ==============================================================================
createUploadLink({
new UploadHttpLink({
uri: "http://localhost",
isExtractableFile,
formDataAppendFile,
Expand Down
45 changes: 0 additions & 45 deletions types/apollo-upload-client/createUploadLink.d.mts

This file was deleted.

8 changes: 4 additions & 4 deletions types/apollo-upload-client/package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"private": true,
"name": "@types/apollo-upload-client",
"version": "18.0.9999",
"version": "19.0.9999",
"projects": [
"https://github.com/jaydenseric/apollo-upload-client#readme"
],
"exports": {
"./createUploadLink.mjs": {
"types": "./createUploadLink.d.mts"
"./UploadHttpLink.mjs": {
"types": "./UploadHttpLink.d.mts"
},
"./formDataAppendFile.mjs": {
"types": "./formDataAppendFile.d.mts"
Expand All @@ -18,7 +18,7 @@
"./package.json": "./package.json"
},
"dependencies": {
"@apollo/client": "^3.8.0",
"@apollo/client": "^4.0.0",
"@types/extract-files": "*",
"graphql": "14 - 16"
},
Expand Down
2 changes: 1 addition & 1 deletion types/apollo-upload-client/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"files": [
"index.d.ts",
"apollo-upload-client-tests.ts",
"createUploadLink.d.mts",
"UploadHttpLink.d.mts",
"formDataAppendFile.d.mts",
"isExtractableFile.d.mts"
]
Expand Down