refactor(server): e2e utilities (#11000)

packages/common/graphql/src/__tests__/fetcher.spec.ts

@@ -0,0 +1,107 @@
+import type { Mock } from 'vitest';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+
+import { gqlFetcherFactory } from '../fetcher';
+import type { GraphQLQuery } from '../graphql';
+
+const query: GraphQLQuery = {
+  id: 'query',
+  query: 'query { field }',
+  op: 'query',
+};
+
+let fetch: Mock;
+let gql: ReturnType<typeof gqlFetcherFactory>;
+describe('GraphQL fetcher', () => {
+  beforeEach(() => {
+    fetch = vi.fn(() =>
+      Promise.resolve(
+        new Response(JSON.stringify({ data: { field: 1 } }), {
+          headers: {
+            'content-type': 'application/json',
+          },
+        })
+      )
+    );
+    gql = gqlFetcherFactory('https://example.com/graphql', fetch);
+  });
+
+  afterEach(() => {
+    fetch.mockReset();
+  });
+
+  it('should send POST request to given endpoint', async () => {
+    await gql(
+      // @ts-expect-error variables is actually optional
+      { query }
+    );
+
+    expect(fetch).toBeCalledTimes(1);
+    expect(fetch.mock.lastCall?.[0]).toBe('https://example.com/graphql');
+    const ctx = fetch.mock.lastCall?.[1] as RequestInit;
+    expect(ctx.method).toBe('POST');
+  });
+
+  it('should send with correct graphql JSON body', async () => {
+    await gql({
+      query,
+      // @ts-expect-error forgive the fake variables
+      variables: { a: 1, b: '2', c: { d: false } },
+    });
+
+    expect(fetch.mock.lastCall?.[1]).toEqual(
+      expect.objectContaining({
+        body: '{"query":"query { field }","variables":{"a":1,"b":"2","c":{"d":false}},"operationName":"query"}',
+        headers: expect.objectContaining({
+          'content-type': 'application/json',
+          'x-operation-name': 'query',
+        }),
+        method: 'POST',
+      })
+    );
+  });
+
+  it('should correctly ignore nil variables', async () => {
+    await gql({
+      query,
+      // @ts-expect-error forgive the fake variables
+      variables: { a: false, b: null, c: undefined },
+    });
+
+    expect(fetch.mock.lastCall?.[1].body).toMatchInlineSnapshot(
+      `"{"query":"query { field }","variables":{"a":false,"b":null},"operationName":"query"}"`
+    );
+
+    await gql({
+      query,
+      // @ts-expect-error forgive the fake variables
+      variables: { a: false, b: null, c: undefined },
+      keepNilVariables: false,
+    });
+
+    expect(fetch.mock.lastCall?.[1].body).toMatchInlineSnapshot(
+      `"{"query":"query { field }","variables":{"a":false},"operationName":"query"}"`
+    );
+  });
+
+  it('should correct handle graphql error', async () => {
+    fetch.mockResolvedValue(
+      new Response(
+        JSON.stringify({
+          data: null,
+          errors: [{ message: 'error', path: ['field'] }],
+        }),
+        {
+          headers: {
+            'content-type': 'application/json',
+          },
+          status: 400,
+        }
+      )
+    );
+
+    await expect(
+      gql({ query, variables: void 0 })
+    ).rejects.toMatchInlineSnapshot(`[GraphQLError: error]`);
+  });
+});

packages/common/graphql/src/fetcher.ts

@@ -0,0 +1,237 @@
+import { DebugLogger } from '@affine/debug';
+import { GraphQLError } from '@affine/error';
+import type { ExecutionResult } from 'graphql';
+import { isNil, isObject, merge } from 'lodash-es';
+
+import type { GraphQLQuery } from './graphql';
+import type { Mutations, Queries } from './schema';
+
+export type NotArray<T> = T extends Array<unknown> ? never : T;
+
+export type FetchInit = RequestInit & { timeout?: number };
+
+export type _QueryVariables<Q extends GraphQLQuery> =
+  Q['id'] extends Queries['name']
+    ? Extract<Queries, { name: Q['id'] }>['variables']
+    : Q['id'] extends Mutations['name']
+      ? Extract<Mutations, { name: Q['id'] }>['variables']
+      : undefined;
+
+export type QueryVariables<Q extends GraphQLQuery> =
+  _QueryVariables<Q> extends never | Record<string, never>
+    ? never
+    : _QueryVariables<Q>;
+
+export type QueryResponse<Q extends GraphQLQuery> = Extract<
+  Queries | Mutations,
+  { name: Q['id'] }
+>['response'];
+
+type NullableKeys<T> = {
+  [K in keyof T]: null extends T[K] ? K : never;
+}[keyof T];
+
+type NonNullableKeys<T> = {
+  [K in keyof T]: null extends T[K] ? never : K;
+}[keyof T];
+
+export type RecursiveMaybeFields<T> = T extends
+  | number
+  | boolean
+  | string
+  | null
+  | undefined
+  ? T
+  : {
+      [K in NullableKeys<T>]?: RecursiveMaybeFields<T[K]>;
+    } & {
+      [K in NonNullableKeys<T>]: RecursiveMaybeFields<T[K]>;
+    };
+
+type AllowedRequestContext = Omit<RequestInit, 'method' | 'body'>;
+
+export interface RequestBody {
+  operationName?: string;
+  variables: any;
+  query: string;
+  form?: FormData;
+}
+
+type QueryVariablesOption<Q extends GraphQLQuery> =
+  QueryVariables<Q> extends never
+    ? {
+        variables?: undefined;
+      }
+    : { variables: RecursiveMaybeFields<QueryVariables<Q>> };
+
+export type RequestOptions<Q extends GraphQLQuery> = QueryVariablesOption<Q> & {
+  /**
+   * parameter passed to `fetch` function
+   */
+  context?: AllowedRequestContext;
+  /**
+   * Whether keep null or undefined value in variables.
+   *
+   * if `false` given, `{ a: 0, b: undefined, c: null }` will be converted to `{ a: 0 }`
+   *
+   * @default true
+   */
+  keepNilVariables?: boolean;
+  /**
+   * Request timeout in milliseconds
+   * @default 15000
+   */
+  timeout?: number;
+};
+
+export type QueryOptions<Q extends GraphQLQuery> = RequestOptions<Q> & {
+  query: Q;
+};
+export type MutationOptions<M extends GraphQLQuery> = RequestOptions<M> & {
+  mutation: M;
+};
+
+function filterEmptyValue(vars: any) {
+  const newVars: Record<string, any> = {};
+  Object.entries(vars).forEach(([key, value]) => {
+    if (isNil(value)) {
+      return;
+    }
+    if (isObject(value) && !(value instanceof File)) {
+      newVars[key] = filterEmptyValue(value);
+      return;
+    }
+    newVars[key] = value;
+  });
+
+  return newVars;
+}
+
+export function transformToForm(body: RequestBody) {
+  const form = new FormData();
+  const gqlBody: {
+    name?: string;
+    query: string;
+    variables: any;
+    map: any;
+  } = {
+    query: body.query,
+    variables: body.variables,
+    map: {},
+  };
+
+  if (body.operationName) {
+    gqlBody.name = body.operationName;
+  }
+  const map: Record<string, string[]> = {};
+  const files: File[] = [];
+  if (body.variables) {
+    let i = 0;
+    const buildMap = (key: string, value: any) => {
+      if (value instanceof File) {
+        map['' + i] = [key];
+        files[i] = value;
+        i++;
+      } else if (Array.isArray(value)) {
+        value.forEach((v, index) => {
+          buildMap(`${key}.${index}`, v);
+        });
+      } else if (isObject(value)) {
+        Object.entries(value).forEach(([k, v]) => {
+          buildMap(`${key}.${k}`, v);
+        });
+      }
+    };
+    buildMap('variables', body.variables);
+  }
+
+  form.set('operations', JSON.stringify(gqlBody));
+  form.set('map', JSON.stringify(map));
+  for (const [i, file] of files.entries()) {
+    form.set(`${i}`, file);
+  }
+  return form;
+}
+
+function formatRequestBody<Q extends GraphQLQuery>({
+  query,
+  variables,
+  keepNilVariables,
+}: QueryOptions<Q>): RequestBody | FormData {
+  const body: RequestBody = {
+    query: query.query,
+    variables:
+      (keepNilVariables ?? true) ? variables : filterEmptyValue(variables),
+  };
+
+  if (query.op) {
+    body.operationName = query.op;
+  }
+
+  if (query.file) {
+    return transformToForm(body);
+  }
+  return body;
+}
+
+export const gqlFetcherFactory = (
+  endpoint: string,
+  fetcher: (input: string, init?: FetchInit) => Promise<Response> = fetch
+) => {
+  const logger = new DebugLogger('GraphQL');
+  const gqlFetch = async <Query extends GraphQLQuery>(
+    options: QueryOptions<Query>
+  ): Promise<QueryResponse<Query>> => {
+    if (
+      BUILD_CONFIG.appBuildType === 'canary' &&
+      options.query.deprecations?.length
+    ) {
+      options.query.deprecations.forEach(deprecation => {
+        logger.warn(deprecation);
+      });
+    }
+
+    const body = formatRequestBody(options);
+
+    const isFormData = body instanceof FormData;
+    const headers: Record<string, string> = {
+      'x-operation-name': options.query.op,
+    };
+    if (!isFormData) {
+      headers['content-type'] = 'application/json';
+    }
+    const ret = fetcher(
+      endpoint,
+      merge(options.context, {
+        method: 'POST',
+        headers,
+        body: isFormData ? body : JSON.stringify(body),
+        timeout: options.timeout,
+      })
+    ).then(async res => {
+      if (res.headers.get('content-type')?.startsWith('application/json')) {
+        const result = (await res.json()) as ExecutionResult;
+        if (res.status >= 400 || result.errors) {
+          if (result.errors && result.errors.length > 0) {
+            // throw the first error is enough
+            const firstError = result.errors[0];
+            throw new GraphQLError(firstError.message, firstError);
+          } else {
+            throw new GraphQLError('Empty GraphQL error body');
+          }
+        } else if (result.data) {
+          // we have to cast here because the type of result.data is a union type
+          return result.data as any;
+        }
+      }
+
+      throw new GraphQLError(
+        'GraphQL query responds unexpected result, query ' + options.query.op
+      );
+    });
+
+    return ret;
+  };
+
+  return gqlFetch;
+};

packages/common/graphql/src/graphql/activate-license.gql

@@ -0,0 +1,6 @@
+mutation activateLicense($workspaceId: String!, $license: String!) {
+  activateLicense(workspaceId: $workspaceId, license: $license) {
+   installedAt
+   validatedAt
+  }
+}

packages/common/graphql/src/graphql/admin-server-config.gql

@@ -0,0 +1,23 @@
+#import './fragments/password-limits.gql'
+#import './fragments/credentials-requirement.gql'
+
+query adminServerConfig {
+  serverConfig {
+    version
+    baseUrl
+    name
+    features
+    type
+    initialized
+    credentialsRequirement {
+      ...CredentialsRequirements
+    }
+    availableUpgrade {
+      changelog
+      version
+      publishedAt
+      url
+    }
+    availableUserFeatures
+  }
+}

packages/common/graphql/src/graphql/blob-delete.gql

@@ -0,0 +1,7 @@
+mutation deleteBlob(
+  $workspaceId: String!
+  $key: String!
+  $permanently: Boolean
+) {
+  deleteBlob(workspaceId: $workspaceId, key: $key, permanently: $permanently)
+}

packages/common/graphql/src/graphql/blob-list.gql

@@ -0,0 +1,10 @@
+query listBlobs($workspaceId: String!) {
+  workspace(id: $workspaceId) {
+    blobs {
+      key
+      size
+      mime
+      createdAt
+    }
+  }
+}

packages/common/graphql/src/graphql/blob-release-deleted.gql

@@ -0,0 +1,3 @@
+mutation releaseDeletedBlobs($workspaceId: String!) {
+  releaseDeletedBlobs(workspaceId: $workspaceId)
+}

packages/common/graphql/src/graphql/blob-set.gql

@@ -0,0 +1,3 @@
+mutation setBlob($workspaceId: String!, $blob: Upload!) {
+  setBlob(workspaceId: $workspaceId, blob: $blob)
+}

packages/common/graphql/src/graphql/cancel-subscription.gql

@@ -0,0 +1,11 @@
+mutation cancelSubscription(
+  $plan: SubscriptionPlan = Pro
+  $workspaceId: String
+) {
+  cancelSubscription(plan: $plan, workspaceId: $workspaceId) {
+    id
+    status
+    nextBillAt
+    canceledAt
+  }
+}

packages/common/graphql/src/graphql/change-email.gql

@@ -0,0 +1,6 @@
+mutation changeEmail($token: String!, $email: String!) {
+  changeEmail(token: $token, email: $email) {
+    id
+    email
+  }
+}

packages/common/graphql/src/graphql/change-password-url.gql

@@ -0,0 +1,3 @@
+mutation createChangePasswordUrl($callbackUrl: String!, $userId: String!) {
+  createChangePasswordUrl(callbackUrl: $callbackUrl, userId: $userId)
+}

packages/common/graphql/src/graphql/change-password.gql

@@ -0,0 +1,7 @@
+mutation changePassword(
+  $token: String!
+  $userId: String!
+  $newPassword: String!
+) {
+  changePassword(token: $token, userId: $userId, newPassword: $newPassword)
+}

packages/common/graphql/src/graphql/copilot-context-category-add.gql

@@ -0,0 +1,7 @@
+mutation addContextCategory($options: AddRemoveContextCategoryInput!) {
+  addContextCategory(options: $options) {
+    id
+    createdAt
+    type
+  }
+}

packages/common/graphql/src/graphql/copilot-context-category-remove.gql

@@ -0,0 +1,3 @@
+mutation removeContextCategory($options: AddRemoveContextCategoryInput!) {
+  removeContextCategory(options: $options)
+}

packages/common/graphql/src/graphql/copilot-context-create.gql

@@ -0,0 +1,3 @@
+mutation createCopilotContext($workspaceId: String!, $sessionId: String!) {
+  createCopilotContext(workspaceId: $workspaceId, sessionId: $sessionId)
+}

packages/common/graphql/src/graphql/copilot-context-doc-add.gql

@@ -0,0 +1,7 @@
+mutation addContextDoc($options: AddContextDocInput!) {
+  addContextDoc(options: $options) {
+    id
+    createdAt
+    status
+  }
+}

packages/common/graphql/src/graphql/copilot-context-doc-remove.gql

@@ -0,0 +1,3 @@
+mutation removeContextDoc($options: RemoveContextDocInput!) {
+  removeContextDoc(options: $options)
+}

packages/common/graphql/src/graphql/copilot-context-file-add.gql

@@ -0,0 +1,11 @@
+mutation addContextFile($content: Upload!, $options: AddContextFileInput!) {
+  addContextFile(content: $content, options: $options) {
+    id
+    createdAt
+    name
+    chunkSize
+    error
+    status
+    blobId
+  }
+}

packages/common/graphql/src/graphql/copilot-context-file-match.gql

@@ -0,0 +1,14 @@
+query matchContext($contextId: String!, $content: String!, $limit: SafeInt) {
+  currentUser {
+    copilot {
+      contexts(contextId: $contextId) {
+        matchContext(content: $content, limit: $limit) {
+          fileId
+          chunk
+          content
+          distance
+        }
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/copilot-context-file-remove.gql

@@ -0,0 +1,3 @@
+mutation removeContextFile($options: RemoveContextFileInput!) {
+  removeContextFile(options: $options)
+}

packages/common/graphql/src/graphql/copilot-context-list-object.gql

@@ -0,0 +1,26 @@
+query listContextObject(
+  $workspaceId: String!
+  $sessionId: String!
+  $contextId: String!
+) {
+  currentUser {
+    copilot(workspaceId: $workspaceId) {
+      contexts(sessionId: $sessionId, contextId: $contextId) {
+        docs {
+          id
+          status
+          createdAt
+        }
+        files {
+          id
+          name
+          blobId
+          chunkSize
+          error
+          status
+          createdAt
+        }
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/copilot-context-list.gql

@@ -0,0 +1,10 @@
+query listContext($workspaceId: String!, $sessionId: String!) {
+  currentUser {
+    copilot(workspaceId: $workspaceId) {
+      contexts(sessionId: $sessionId) {
+        id
+        workspaceId
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/copilot-context-workspace-match.gql

@@ -0,0 +1,14 @@
+query matchWorkspaceContext($contextId: String!, $content: String!, $limit: SafeInt) {
+  currentUser {
+    copilot {
+      contexts(contextId: $contextId) {
+        matchWorkspaceContext(content: $content, limit: $limit) {
+          docId
+          chunk
+          content
+          distance
+        }
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/copilot-context-workspace-query.gql

@@ -0,0 +1,6 @@
+query getWorkspaceEmbeddingStatus($workspaceId: String!) {
+  queryWorkspaceEmbeddingStatus(workspaceId: $workspaceId) {
+    total
+    embedded
+  }
+}

packages/common/graphql/src/graphql/copilot-context-workspace-queue.gql

@@ -0,0 +1,3 @@
+mutation queueWorkspaceEmbedding($workspaceId: String!, $docId: [String!]!) {
+  queueWorkspaceEmbedding(workspaceId: $workspaceId, docId: $docId)
+}

packages/common/graphql/src/graphql/copilot-history-get-ids.gql

@@ -0,0 +1,18 @@
+query getCopilotHistoryIds(
+  $workspaceId: String!
+  $docId: String
+  $options: QueryChatHistoriesInput
+) {
+  currentUser {
+    copilot(workspaceId: $workspaceId) {
+      histories(docId: $docId, options: $options) {
+        sessionId
+        messages {
+          id
+          role
+          createdAt
+        }
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/copilot-history-list.gql

@@ -0,0 +1,23 @@
+query getCopilotHistories(
+  $workspaceId: String!
+  $docId: String
+  $options: QueryChatHistoriesInput
+) {
+  currentUser {
+    copilot(workspaceId: $workspaceId) {
+      histories(docId: $docId, options: $options) {
+        sessionId
+        tokens
+        action
+        createdAt
+        messages {
+          id
+          role
+          content
+          attachments
+          createdAt
+        }
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/copilot-message-create.gql

@@ -0,0 +1,3 @@
+mutation createCopilotMessage($options: CreateChatMessageInput!) {
+  createCopilotMessage(options: $options)
+}

packages/common/graphql/src/graphql/copilot-prompt-list.gql

@@ -0,0 +1,19 @@
+query getPrompts {
+  listCopilotPrompts {
+    name
+    model
+    action
+    config {
+      jsonMode
+      frequencyPenalty
+      presencePenalty
+      temperature
+      topP
+    }
+    messages {
+      role
+      content
+      params
+    }
+  }
+}

packages/common/graphql/src/graphql/copilot-prompt-update.gql

@@ -0,0 +1,22 @@
+mutation updatePrompt(
+  $name: String!
+  $messages: [CopilotPromptMessageInput!]!
+) {
+  updateCopilotPrompt(name: $name, messages: $messages) {
+    name
+    model
+    action
+    config {
+      jsonMode
+      frequencyPenalty
+      presencePenalty
+      temperature
+      topP
+    }
+    messages {
+      role
+      content
+      params
+    }
+  }
+}

packages/common/graphql/src/graphql/copilot-quota.gql

@@ -0,0 +1,10 @@
+query copilotQuota {
+  currentUser {
+    copilot {
+      quota {
+        limit
+        used
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/copilot-session-cleanup.gql

@@ -0,0 +1,3 @@
+mutation cleanupCopilotSession($input: DeleteSessionInput!) {
+  cleanupCopilotSession(options: $input)
+}

packages/common/graphql/src/graphql/copilot-session-create.gql

@@ -0,0 +1,3 @@
+mutation createCopilotSession($options: CreateChatSessionInput!) {
+  createCopilotSession(options: $options)
+}

packages/common/graphql/src/graphql/copilot-session-fork.gql

@@ -0,0 +1,3 @@
+mutation forkCopilotSession($options: ForkChatSessionInput!) {
+  forkCopilotSession(options: $options)
+}

packages/common/graphql/src/graphql/copilot-session-update.gql

@@ -0,0 +1,3 @@
+mutation updateCopilotSession($options: UpdateChatSessionInput!) {
+  updateCopilotSession(options: $options)
+}

packages/common/graphql/src/graphql/copilot-sessions-get.gql

@@ -0,0 +1,15 @@
+query getCopilotSessions(
+  $workspaceId: String!
+  $docId: String
+  $options: QueryChatSessionsInput
+) {
+  currentUser {
+    copilot(workspaceId: $workspaceId) {
+      sessions(docId: $docId, options: $options) {
+        id
+        parentSessionId
+        promptName
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/create-checkout-link.gql

@@ -0,0 +1,3 @@
+mutation createCheckoutSession($input: CreateCheckoutSessionInput!) {
+  createCheckoutSession(input: $input)
+}

packages/common/graphql/src/graphql/create-customer-portal.gql

@@ -0,0 +1,3 @@
+mutation createCustomerPortal {
+  createCustomerPortal
+}

packages/common/graphql/src/graphql/create-self-host-customer-portal.gql

@@ -0,0 +1,3 @@
+mutation createSelfhostCustomerPortal ($workspaceId: String!) {
+  createSelfhostWorkspaceCustomerPortal(workspaceId: $workspaceId)
+}

packages/common/graphql/src/graphql/create-user.gql

@@ -0,0 +1,5 @@
+mutation createUser($input: CreateUserInput!) {
+  createUser(input: $input) {
+    id
+  }
+}

packages/common/graphql/src/graphql/create-workspace.gql

@@ -0,0 +1,7 @@
+mutation createWorkspace {
+  createWorkspace {
+    id
+    public
+    createdAt
+  }
+}

packages/common/graphql/src/graphql/deactivate-license.gql

@@ -0,0 +1,3 @@
+mutation deactivateLicense($workspaceId: String!) {
+  deactivateLicense(workspaceId: $workspaceId)
+}

packages/common/graphql/src/graphql/delete-account.gql

@@ -0,0 +1,5 @@
+mutation deleteAccount {
+  deleteAccount {
+    success
+  }
+}

packages/common/graphql/src/graphql/delete-user.gql

@@ -0,0 +1,5 @@
+mutation deleteUser($id: String!) {
+  deleteUser(id: $id) {
+    success
+  }
+}

packages/common/graphql/src/graphql/delete-workspace.gql

@@ -0,0 +1,3 @@
+mutation deleteWorkspace($id: String!) {
+  deleteWorkspace(id: $id)
+}

packages/common/graphql/src/graphql/disable-user.gql

@@ -0,0 +1,6 @@
+mutation disableUser($id: String!) {
+  banUser(id: $id) {
+    email
+    disabled
+  }
+}

packages/common/graphql/src/graphql/doc-role-permissions.gql

@@ -0,0 +1,21 @@
+query getDocRolePermissions($workspaceId: String!, $docId: String!) {
+  workspace(id: $workspaceId) {
+    doc(docId: $docId) {
+      permissions {
+        Doc_Copy
+        Doc_Delete
+        Doc_Duplicate
+        Doc_Properties_Read
+        Doc_Properties_Update
+        Doc_Publish
+        Doc_Read
+        Doc_Restore
+        Doc_TransferOwner
+        Doc_Trash
+        Doc_Update
+        Doc_Users_Manage
+        Doc_Users_Read
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/enable-user.gql

@@ -0,0 +1,6 @@
+mutation enableUser($id: String!) {
+  enableUser(id: $id) {
+    email
+    disabled
+  }
+}

packages/common/graphql/src/graphql/fragments/credentials-requirement.gql

@@ -0,0 +1,5 @@
+fragment CredentialsRequirements on CredentialsRequirementType {
+  password {
+    ...PasswordLimits
+  }
+}

packages/common/graphql/src/graphql/fragments/password-limits.gql

@@ -0,0 +1,4 @@
+fragment PasswordLimits on PasswordLimitsType {
+  minLength
+  maxLength
+}

packages/common/graphql/src/graphql/generate-license-key.gql

@@ -0,0 +1,3 @@
+mutation generateLicenseKey($sessionId: String!) {
+  generateLicenseKey(sessionId: $sessionId)
+}

packages/common/graphql/src/graphql/get-current-user-features.gql

@@ -0,0 +1,11 @@
+# for the admin panel only, do not use it in the app
+query getCurrentUserFeatures {
+  currentUser {
+    id
+    name
+    email
+    emailVerified
+    avatarUrl
+    features
+  }
+}

packages/common/graphql/src/graphql/get-current-user.gql

@@ -0,0 +1,12 @@
+query getCurrentUser {
+  currentUser {
+    id
+    name
+    email
+    emailVerified
+    avatarUrl
+    token {
+      sessionToken
+    }
+  }
+}

packages/common/graphql/src/graphql/get-doc-default-role.gql

@@ -0,0 +1,7 @@
+query getDocDefaultRole($workspaceId: String!, $docId: String!) {
+  workspace(id: $workspaceId) {
+    doc(docId: $docId) {
+      defaultRole
+    }
+  }
+}

packages/common/graphql/src/graphql/get-invite-info.gql

@@ -0,0 +1,14 @@
+query getInviteInfo($inviteId: String!) {
+  getInviteInfo(inviteId: $inviteId) {
+    workspace {
+      id
+      name
+      avatar
+    }
+    user {
+      id
+      name
+      avatarUrl
+    }
+  }
+}

packages/common/graphql/src/graphql/get-is-admin.gql

@@ -0,0 +1,3 @@
+query getIsAdmin($workspaceId: String!) {
+  isAdmin(workspaceId: $workspaceId)
+}

packages/common/graphql/src/graphql/get-is-owner.gql

@@ -0,0 +1,3 @@
+query getIsOwner($workspaceId: String!) {
+  isOwner(workspaceId: $workspaceId)
+}

packages/common/graphql/src/graphql/get-license.gql

@@ -0,0 +1,11 @@
+query getLicense($workspaceId: String!) {
+  workspace(id: $workspaceId) {
+    license {
+      expiredAt
+      installedAt
+      quantity
+      recurring
+      validatedAt
+    }
+  }
+}

packages/common/graphql/src/graphql/get-member-count-by-workspace-id.gql

@@ -0,0 +1,5 @@
+query getMemberCountByWorkspaceId($workspaceId: String!) {
+  workspace(id: $workspaceId) {
+    memberCount
+  }
+}

packages/common/graphql/src/graphql/get-members-by-workspace-id.gql

@@ -0,0 +1,15 @@
+query getMembersByWorkspaceId($workspaceId: String!, $skip: Int, $take: Int, $query: String) {
+  workspace(id: $workspaceId) {
+    memberCount
+    members(skip: $skip, take: $take, query: $query) {
+      id
+      name
+      email
+      avatarUrl
+      permission
+      inviteId
+      emailVerified
+      status
+    }
+  }
+}

packages/common/graphql/src/graphql/get-oauth-providers.gql

@@ -0,0 +1,5 @@
+query oauthProviders {
+  serverConfig {
+    oauthProviders
+  }
+}

packages/common/graphql/src/graphql/get-page-granted-users-list.gql

@@ -0,0 +1,24 @@
+query getPageGrantedUsersList($pagination: PaginationInput!, $docId: String!, $workspaceId: String!) {
+  workspace(id: $workspaceId) {
+    doc(docId: $docId) {
+      grantedUsersList(pagination: $pagination) {
+        totalCount
+        pageInfo {
+          endCursor
+          hasNextPage
+        }
+        edges {
+          node {
+            role
+            user {
+              id
+              name
+              email
+              avatarUrl
+            }
+          }
+        }
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/get-public-user-by-id.gql

@@ -0,0 +1,7 @@
+query getPublicUserById($id: String!) {
+    publicUserById(id: $id) {
+        id
+        avatarUrl
+        name
+    }
+}

packages/common/graphql/src/graphql/get-server-runtime-config.gql

@@ -0,0 +1,11 @@
+query getServerRuntimeConfig {
+  serverRuntimeConfig {
+    id
+    module
+    key
+    description
+    value
+    type
+    updatedAt
+  }
+}

packages/common/graphql/src/graphql/get-server-service-configs.gql

@@ -0,0 +1,6 @@
+query getServerServiceConfigs {
+  serverServiceConfigs {
+    name
+    config
+  }
+}

packages/common/graphql/src/graphql/get-user-by-email.gql

@@ -0,0 +1,20 @@
+query getUserByEmail($email: String!) {
+  userByEmail(email: $email) {
+    id
+    name
+    email
+    features
+    hasPassword
+    emailVerified
+    avatarUrl
+    quota {
+      humanReadable {
+        blobLimit
+        historyPeriod
+        memberLimit
+        name
+        storageQuota
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/get-user-features.gql

@@ -0,0 +1,6 @@
+query getUserFeatures {
+  currentUser {
+    id
+    features
+  }
+}

packages/common/graphql/src/graphql/get-user.gql

@@ -0,0 +1,16 @@
+query getUser($email: String!) {
+  user(email: $email) {
+    __typename
+    ... on UserType {
+      id
+      name
+      avatarUrl
+      email
+      hasPassword
+    }
+    ... on LimitedUserType {
+      email
+      hasPassword
+    }
+  }
+}

packages/common/graphql/src/graphql/get-users-count.gql

@@ -0,0 +1,3 @@
+query getUsersCount {
+  usersCount
+}

packages/common/graphql/src/graphql/get-workspace-info.gql

@@ -0,0 +1,7 @@
+query getWorkspaceInfo($workspaceId: String!) {
+  isAdmin(workspaceId: $workspaceId)
+  isOwner(workspaceId: $workspaceId)
+  workspace(id: $workspaceId) {
+    team
+  }
+}

packages/common/graphql/src/graphql/get-workspace-page-by-id.gql

@@ -0,0 +1,10 @@
+query getWorkspacePageById($workspaceId: String!, $pageId: String!) {
+  workspace(id: $workspaceId) {
+    doc(docId: $pageId) {
+      id
+      mode
+      defaultRole
+      public
+    }
+  }
+}

packages/common/graphql/src/graphql/get-workspace-page-meta.gql

@@ -0,0 +1,16 @@
+query getWorkspacePageMetaById($id: String!, $pageId: String!) {
+  workspace(id: $id) {
+    pageMeta(pageId: $pageId) {
+      createdAt
+      updatedAt
+      createdBy {
+        name
+        avatarUrl
+      }
+      updatedBy {
+        name
+        avatarUrl
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/get-workspace-public-by-id.gql

@@ -0,0 +1,5 @@
+query getWorkspacePublicById($id: String!) {
+  workspace(id: $id) {
+    public
+  }
+}

packages/common/graphql/src/graphql/get-workspace-public-pages.gql

@@ -0,0 +1,8 @@
+query getWorkspacePublicPages($workspaceId: String!) {
+  workspace(id: $workspaceId) {
+    publicDocs {
+      id
+      mode
+    }
+  }
+}

packages/common/graphql/src/graphql/get-workspace-subscription.gql

@@ -0,0 +1,15 @@
+query getWorkspaceSubscription($workspaceId: String!) {
+  workspace(id: $workspaceId) {
+    subscription {
+      id
+      status
+      plan
+      recurring
+      start
+      end
+      nextBillAt
+      canceledAt
+      variant
+    }
+  }
+}

packages/common/graphql/src/graphql/get-workspace.gql

@@ -0,0 +1,5 @@
+query getWorkspace($id: String!) {
+  workspace(id: $id) {
+    id
+  }
+}

packages/common/graphql/src/graphql/get-workspaces.gql

@@ -0,0 +1,10 @@
+query getWorkspaces {
+  workspaces {
+    id
+    initialized
+    team
+    owner {
+      id
+    }
+  }
+}

packages/common/graphql/src/graphql/grant-doc-user-roles.gql

@@ -0,0 +1,3 @@
+mutation grantDocUserRoles($input: GrantDocUserRolesInput!) {
+  grantDocUserRoles(input: $input)
+}

packages/common/graphql/src/graphql/histories.gql

@@ -0,0 +1,17 @@
+query listHistory(
+  $workspaceId: String!
+  $pageDocId: String!
+  $take: Int
+  $before: DateTime
+) {
+  workspace(id: $workspaceId) {
+    histories(guid: $pageDocId, take: $take, before: $before) {
+      id
+      timestamp
+      editor {
+        name
+        avatarUrl
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/import-users.gql

@@ -0,0 +1,14 @@
+mutation ImportUsers($input: ImportUsersInput!) {
+  importUsers(input: $input) {
+    __typename
+    ... on UserType {
+      id
+      name
+      email
+    }
+    ... on UserImportFailedType {
+      email
+      error
+    }
+  }
+}

packages/common/graphql/src/graphql/invoices-count.gql

@@ -0,0 +1,5 @@
+query getInvoicesCount {
+  currentUser {
+    invoiceCount
+  }
+}

packages/common/graphql/src/graphql/invoices.gql

@@ -0,0 +1,15 @@
+query invoices($take: Int!, $skip: Int!) {
+  currentUser {
+    invoiceCount
+    invoices(take: $take, skip: $skip) {
+      id
+      status
+      currency
+      amount
+      reason
+      lastPaymentError
+      link
+      createdAt
+    }
+  }
+}

packages/common/graphql/src/graphql/leave-workspace.gql

@@ -0,0 +1,3 @@
+mutation leaveWorkspace($workspaceId: String!, $sendLeaveMail: Boolean) {
+  leaveWorkspace(workspaceId: $workspaceId, sendLeaveMail: $sendLeaveMail)
+}

packages/common/graphql/src/graphql/list-notifications.gql

@@ -0,0 +1,25 @@
+query listNotifications($pagination: PaginationInput!) {
+  currentUser {
+    notifications(pagination: $pagination) {
+      totalCount
+      edges {
+        cursor
+        node {
+          id
+          type
+          level
+          read
+          createdAt
+          updatedAt
+          body
+        }
+      }
+      pageInfo {
+        startCursor
+        endCursor
+        hasNextPage
+        hasPreviousPage
+      }
+    }
+  }
+}

packages/common/graphql/src/graphql/list-users.gql

@@ -0,0 +1,12 @@
+query listUsers($filter: ListUserInput!) {
+  users(filter: $filter) {
+    id
+    name
+    email
+    disabled
+    features
+    hasPassword
+    emailVerified
+    avatarUrl
+  }
+}

packages/common/graphql/src/graphql/mention-user.gql

@@ -0,0 +1,3 @@
+mutation mentionUser($input: MentionInput!) {
+  mentionUser(input: $input)
+} 

packages/common/graphql/src/graphql/notification-count.gql

@@ -0,0 +1,5 @@
+query notificationCount {
+    currentUser {
+        notificationCount
+    }
+}

packages/common/graphql/src/graphql/prices.gql

@@ -0,0 +1,10 @@
+query prices {
+  prices {
+    type
+    plan
+    currency
+    amount
+    yearlyAmount
+    lifetimeAmount
+  }
+}

packages/common/graphql/src/graphql/public-page.gql

@@ -0,0 +1,10 @@
+mutation publishPage(
+  $workspaceId: String!
+  $pageId: String!
+  $mode: PublicDocMode = Page
+) {
+  publishDoc(workspaceId: $workspaceId, docId: $pageId, mode: $mode) {
+    id
+    mode
+  }
+}

packages/common/graphql/src/graphql/quota.gql

@@ -0,0 +1,22 @@
+query quota {
+  currentUser {
+    id
+    quota {
+      name
+      blobLimit
+      storageQuota
+      historyPeriod
+      memberLimit
+      humanReadable {
+        name
+        blobLimit
+        storageQuota
+        historyPeriod
+        memberLimit
+      }
+    }
+    quotaUsage {
+      storageQuota
+    }
+  }
+}

packages/common/graphql/src/graphql/read-notification.gql

@@ -0,0 +1,3 @@
+mutation readNotification($id: String!) {
+  readNotification(id: $id)
+}

packages/common/graphql/src/graphql/recover-doc.gql

@@ -0,0 +1,7 @@
+mutation recoverDoc(
+  $workspaceId: String!
+  $docId: String!
+  $timestamp: DateTime!
+) {
+  recoverDoc(workspaceId: $workspaceId, guid: $docId, timestamp: $timestamp)
+}

packages/common/graphql/src/graphql/remove-avatar.gql

@@ -0,0 +1,5 @@
+mutation removeAvatar {
+  removeAvatar {
+    success
+  }
+}

packages/common/graphql/src/graphql/resume-subscription.gql

@@ -0,0 +1,12 @@
+mutation resumeSubscription(
+  $plan: SubscriptionPlan = Pro
+  $workspaceId: String
+) {
+  resumeSubscription(plan: $plan, workspaceId: $workspaceId) {
+    id
+    status
+    nextBillAt
+    start
+    end
+  }
+}

packages/common/graphql/src/graphql/revoke-doc-user-roles.gql

@@ -0,0 +1,3 @@
+mutation revokeDocUserRoles($input: RevokeDocUserRoleInput!) {
+  revokeDocUserRoles(input: $input)
+}

packages/common/graphql/src/graphql/revoke-member-permission.gql

@@ -0,0 +1,3 @@
+mutation revokeMemberPermission($workspaceId: String!, $userId: String!) {
+  revoke(workspaceId: $workspaceId, userId: $userId)
+}

packages/common/graphql/src/graphql/revoke-public-page.gql

@@ -0,0 +1,7 @@
+mutation revokePublicPage($workspaceId: String!, $pageId: String!) {
+  revokePublicDoc(workspaceId: $workspaceId, docId: $pageId) {
+    id
+    mode
+    public
+  }
+}

packages/common/graphql/src/graphql/send-change-email.gql

@@ -0,0 +1,3 @@
+mutation sendChangeEmail($callbackUrl: String!) {
+  sendChangeEmail(callbackUrl: $callbackUrl)
+}

packages/common/graphql/src/graphql/send-change-password-email.gql

@@ -0,0 +1,3 @@
+mutation sendChangePasswordEmail($callbackUrl: String!) {
+  sendChangePasswordEmail(callbackUrl: $callbackUrl)
+}