@rossum/api-client 0.1.24 → 0.1.25

package/src/triggers/models/trigger.schema.ts

@@ -1,24 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { idSchema, urlSchema } from '../../utils/codecUtils.schema';
-
-export const triggerUrlSchema = urlSchema;
-
-export const triggerEventTypeSchema = z.union([
-  z.literal('email_with_no_processable_attachments'),
-  z.literal('annotation_created'),
-  z.literal('annotation_imported'),
-  z.literal('annotation_confirmed'),
-  z.literal('annotation_exported'),
-  z.literal('validation'),
-]);
-
-export const triggerSchema = z.object({
-  id: idSchema,
-  url: urlSchema,
-  queue: urlSchema,
-  event: triggerEventTypeSchema,
-  condition: z.record(z.unknown()).nullable(),
-  emailTemplates: z.array(urlSchema),
-  deleteRecommendations: z.array(urlSchema),
-});

package/src/triggers/models/trigger.ts

@@ -1,21 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-
-export type TriggerUrl = Url;
-
-export type TriggerEventType =
-  | 'email_with_no_processable_attachments'
-  | 'annotation_created'
-  | 'annotation_imported'
-  | 'annotation_confirmed'
-  | 'annotation_exported'
-  | 'validation';
-
-export type Trigger = {
-  id: ID;
-  url: Url;
-  queue: Url;
-  event: TriggerEventType;
-  condition: Record<string, unknown> | null;
-  emailTemplates: Url[];
-  deleteRecommendations: Url[];
-};

package/src/types.schema.ts

@@ -1,4 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const urlSchema = z.string();

package/src/types.ts

@@ -1 +0,0 @@
-export type Url = string;

package/src/uploads/endpoints/get.ts

@@ -1,11 +0,0 @@
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { Upload } from '../models/upload';
-import { uploadSchema } from '../models/upload.schema';
-
-export const get = (uploadId: number) => {
-  return {
-    endpoint: `/uploads/${uploadId}`,
-    method: 'GET',
-    responseSchema: uploadSchema,
-  } as const;
-};

package/src/uploads/endpoints/index.ts

@@ -1,7 +0,0 @@
-import { get } from './get';
-import { post } from './post';
-
-export const uploads = {
-  get,
-  post,
-};

package/src/uploads/endpoints/post.schema.ts

@@ -1,11 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { urlSchema } from '../../utils/codecUtils.schema';
-
-export const uploadsPostQuerySchema = z.object({
-  queue: z.number(),
-});
-
-export const uploadsPostResponseSchema = z.object({
-  url: urlSchema,
-});

package/src/uploads/endpoints/post.ts

@@ -1,37 +0,0 @@
-import { z } from 'zod';
-import { Url } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import {
-  uploadsPostResponseSchema,
-  uploadsPostQuerySchema,
-} from './post.schema';
-
-export type UploadsPostQuery = {
-  queue: number;
-};
-
-export type UploadsPostResponse = {
-  url: Url;
-};
-
-export const post = (
-  queueId: number,
-  data: unknown,
-  name: string = '',
-  signal?: AbortSignal
-) => {
-  const encodedFilename = encodeURIComponent(name);
-  // replace strips trailing slash from the endpoint URL in case of missing filename
-  const endpoint = `/uploads/${encodedFilename}`.replace(/\/$/, '');
-  return {
-    endpoint,
-    method: 'POST',
-    headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
-    query: { queue: queueId },
-    querySchema: uploadsPostQuerySchema,
-    responseSchema: uploadsPostResponseSchema,
-    payloadSchema: z.unknown(),
-    payload: data,
-    signal,
-  } as const;
-};

package/src/uploads/index.ts

@@ -1,3 +0,0 @@
-export * from './models';
-export * from './endpoints';
-

package/src/uploads/models/index.ts

@@ -1,2 +0,0 @@
-export * from './upload';
-export * from './upload.schema';

package/src/uploads/models/upload.schema.ts

@@ -1,16 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { urlSchema } from '../../utils/codecUtils.schema';
-
-export const uploadSchema = z.object({
-  id: z.number(),
-  url: urlSchema,
-  organization: urlSchema,
-  creator: urlSchema.nullable(),
-  createdAt: z.string(),
-  queue: urlSchema,
-  email: urlSchema.nullable(),
-  documents: z.array(urlSchema),
-  additionalDocuments: z.array(urlSchema),
-  annotations: z.array(urlSchema),
-});

package/src/uploads/models/upload.ts

@@ -1,14 +0,0 @@
-import { Url } from '../../utils/codecUtils';
-
-export type Upload = {
-  id: number;
-  url: Url;
-  organization: Url;
-  creator: Url | null;
-  createdAt: string;
-  queue: Url;
-  email: Url | null;
-  documents: Url[];
-  additionalDocuments: Url[];
-  annotations: Url[];
-};

package/src/users/endpoints/create.schema.ts

@@ -1,16 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const createUserPayloadSchema = z.object({
-  authType: z.string(),
-  email: z.string().optional(),
-  groups: z.array(z.string()),
-  queues: z.array(z.string()),
-  username: z.string(),
-  firstName: z.string().optional(),
-  lastName: z.string().optional(),
-  organization: z.string().optional(),
-  password: z.string().optional(),
-  url: z.string().optional(),
-  uiSettings: z.unknown().optional(),
-});

package/src/users/endpoints/create.ts

@@ -1,28 +0,0 @@
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { User } from '../models/user';
-import { userSchema } from '../models/user.schema';
-import { createUserPayloadSchema } from './create.schema';
-
-export type CreateUserPayload = {
-  authType: string;
-  email?: string;
-  groups: string[];
-  queues: string[];
-  username: string;
-  firstName?: string;
-  lastName?: string;
-  organization?: string;
-  password?: string;
-  url?: string;
-  uiSettings?: unknown;
-};
-
-export const create = (payload: CreateUserPayload) => {
-  return {
-    endpoint: `/users`,
-    method: 'POST',
-    responseSchema: userSchema,
-    payloadSchema: createUserPayloadSchema,
-    payload,
-  } as const;
-};

package/src/users/endpoints/delete.ts

@@ -1,10 +0,0 @@
-import { z } from 'zod';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-
-export const deleteEndpoint = (userId: number) => {
-  return {
-    endpoint: `/users/${userId}`,
-    method: 'DELETE',
-    responseSchema: z.unknown(),
-  } as const;
-};

package/src/users/endpoints/get.ts

@@ -1,11 +0,0 @@
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { userSchema } from '../models';
-import { User } from '../models/user';
-
-export const get = (userId: string) => {
-  return {
-    endpoint: `/users/${userId}`,
-    method: 'GET',
-    responseSchema: userSchema,
-  } as const;
-};

package/src/users/endpoints/index.ts

@@ -1,16 +0,0 @@
-import { create } from './create';
-import { deleteEndpoint } from './delete';
-import { get } from './get';
-import { list } from './list';
-import { patch } from './patch';
-import { resetPassword } from './resetPassword';
-export { type UsersListQuery } from './list';
-
-export const users = {
-  delete: deleteEndpoint,
-  create,
-  patch,
-  list,
-  resetPassword,
-  get,
-};

package/src/users/endpoints/list.schema.ts

@@ -1,20 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { paginationQuerySchema } from '../../utils/listQuery.schema';
-
-export const usersListQuerySchema = z
-  .object({
-    id: z.union([z.number(), z.array(z.number())]).optional(),
-    organization: z.string().optional(),
-    username: z.string().optional(),
-    firstName: z.string().optional(),
-    lastName: z.string().optional(),
-    email: z.string().optional(),
-    isActive: z.boolean().optional(),
-    lastLogin: z.string().optional().nullable(),
-    groups: z.array(z.number()).optional(),
-    queues: z.array(z.string()).optional(),
-    deleted: z.boolean().optional(),
-    search: z.string().optional(),
-  })
-  .and(paginationQuerySchema);

package/src/users/endpoints/list.ts

@@ -1,31 +0,0 @@
-import { PaginationQuery } from '../../utils/listQuery';
-import { ListResponse, listResponse } from '../../utils/listResponse';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { userSchema } from '../models';
-import { User } from '../models/user';
-import { usersListQuerySchema } from './list.schema';
-
-export type UsersListQuery = {
-  id?: number | number[];
-  organization?: string;
-  username?: string;
-  firstName?: string;
-  lastName?: string;
-  email?: string;
-  isActive?: boolean;
-  lastLogin?: string | null;
-  groups?: number[];
-  queues?: string[];
-  deleted?: boolean;
-  search?: string;
-} & PaginationQuery;
-
-export const list = (query: UsersListQuery = {}) => {
-  return {
-    endpoint: `/users`,
-    method: 'GET',
-    responseSchema: listResponse(userSchema),
-    query,
-    querySchema: usersListQuerySchema,
-  } as const;
-};

package/src/users/endpoints/patch.schema.ts

@@ -1,5 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { userSchema } from '../models/user.schema';
-
-export const patchUserPayloadSchema = userSchema.partial();

package/src/users/endpoints/patch.ts

@@ -1,17 +0,0 @@
-import { ID } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { User } from '../models/user';
-import { userSchema } from '../models/user.schema';
-import { patchUserPayloadSchema } from './patch.schema';
-
-export type PatchUserPayload = Partial<User>;
-
-export const patch = (userId: ID, payload: PatchUserPayload) => {
-  return {
-    endpoint: `/users/${userId}`,
-    method: 'PATCH',
-    responseSchema: userSchema,
-    payloadSchema: patchUserPayloadSchema,
-    payload,
-  } as const;
-};

package/src/users/endpoints/resetPassword.schema.ts

@@ -1,6 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const resetPayloadSchema = z.object({
-  email: z.string(),
-});

package/src/users/endpoints/resetPassword.ts

@@ -1,18 +0,0 @@
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { ResetPassword } from '../models/resetPassword';
-import { resetPasswordSchema } from '../models/resetPassword.schema';
-import { resetPayloadSchema } from './resetPassword.schema';
-
-export type ResetPayload = {
-  email: string;
-};
-
-export const resetPassword = (payload: ResetPayload) => {
-  return {
-    endpoint: `/auth/password/reset`,
-    method: 'POST',
-    responseSchema: resetPasswordSchema,
-    payloadSchema: resetPayloadSchema,
-    payload,
-  } as const;
-};

package/src/users/index.ts

@@ -1,3 +0,0 @@
-export * from './models';
-export * from './endpoints';
-

package/src/users/models/index.ts

@@ -1,2 +0,0 @@
-export * from './user';
-export * from './user.schema';

package/src/users/models/resetPassword.schema.ts

@@ -1,6 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const resetPasswordSchema = z.object({
-  detail: z.unknown().optional(),
-});

package/src/users/models/resetPassword.ts

@@ -1,3 +0,0 @@
-export type ResetPassword = {
-  detail?: unknown;
-};

package/src/users/models/user.schema.ts

@@ -1,25 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { idSchema, urlSchema } from '../../utils/codecUtils.schema';
-
-export const userSchema = z.object({
-  id: idSchema,
-  url: urlSchema,
-  firstName: z.string().optional(),
-  lastName: z.string(),
-  email: z.string().optional(),
-  emailVerified: z.boolean(),
-  dateJoined: z.string(),
-  username: z.string(),
-  groups: z.array(urlSchema),
-  organization: urlSchema,
-  queues: z.array(urlSchema),
-  isActive: z.boolean(),
-  lastLogin: z.string().nullable(),
-  uiSettings: z.unknown().optional(),
-  metadata: z.unknown().optional(),
-  oidcId: z.string().optional().nullable(),
-  authType: z.union([z.literal('password'), z.literal('sso')]),
-  deleted: z.boolean(),
-  phoneNumber: z.string().nullable(),
-});

package/src/users/models/user.ts

@@ -1,23 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-
-export type User = {
-  id: ID;
-  url: Url;
-  firstName?: string;
-  lastName: string;
-  email?: string;
-  emailVerified: boolean;
-  dateJoined: string;
-  username: string;
-  groups: Array<Url>;
-  organization: Url;
-  queues: Array<Url>;
-  isActive: boolean;
-  lastLogin: string | null;
-  uiSettings?: unknown;
-  metadata?: unknown;
-  oidcId?: string | null;
-  authType: 'password' | 'sso';
-  deleted: boolean;
-  phoneNumber: string | null;
-};

package/src/utils/client.ts

@@ -1,16 +0,0 @@
-/**
- * @noSchema
- */
-// TODO: Will expand this later
-export type ElisContentType = 'application/json' | 'application/pdf';
-
-/**
- * @noSchema
- */
-export type ElisClientConfig = {
-  baseUrl: string;
-  convertKeys?: 'camelCase' | 'none';
-  /** Returns an authentication token */
-  getAuthToken: () => string | null;
-  additionalHeaders?: Record<string, string | undefined>;
-};

package/src/utils/codecUtils.schema.ts

@@ -1,14 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-const iDBrandSchema = z.object({
-  ID: z.any(),
-});
-
-export const idSchema = z.number();
-
-const urlBrandSchema = z.object({
-  Url: z.any(),
-});
-
-export const urlSchema = z.string();

package/src/utils/codecUtils.ts

@@ -1,60 +0,0 @@
-import { pipe } from 'fp-ts/function';
-import * as EI from 'fp-ts/lib/Either';
-import * as D from 'io-ts/lib/Decoder';
-import * as E from 'io-ts/lib/Encoder';
-
-// Just for clarity and potential changes in the future
-interface IDBrand {
-  readonly ID: unique symbol;
-}
-
-export type ID = number; // & IDBrand;
-
-export const ID = pipe(
-  D.number,
-  D.refine((n): n is ID => !Number.isNaN(n) && Number.isSafeInteger(n), 'ID')
-);
-
-// Url helpers
-// We had to disable matching by this regex because some internal "urls" are not actually
-// valid URLs - thus loosening this to just 'string' for now
-// Borrowed from https://stackoverflow.com/questions/3809401/what-is-a-good-regular-expression-to-match-a-url
-// const urlRegex = new RegExp(
-//   /[-a-zA-Z0-9@:%._+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_+.~#?&//=]*)?/gi
-// );
-
-interface UrlBrand {
-  readonly Url: unique symbol;
-}
-
-export type Url = string; // & UrlBrand;
-
-export const Url = pipe(
-  D.string,
-  D.refine((s): s is Url => typeof s === 'string', 'Url')
-);
-
-// TODO: How do we go about encoding number to URL string?
-// With this approach we are throwing part of the context (entity identifier) away
-// so reconstructing URL back from ID is impossible without passing in more information
-// e.g. UrlFromIDEncoder('schemas')
-// Alternatively we could keep both and transform the URL into a tuple [URL, ID] which adds
-// bloat but could save us some work with extracting ID when necessary
-// Example at https://elis.rossum.ai/api/docs/#filters-and-ordering shows
-// that to filter by workspace on a queue you pass just the ID but in create models
-// you need the entire URL - this is an API inconsistency issue
-export const IDFromUrl = pipe(
-  Url,
-  D.map(url => Number(url.split('/').pop())),
-  D.refine((n): n is ID => !Number.isNaN(n) && Number.isSafeInteger(n), 'ID')
-);
-
-export const getIDFromUrl = (url: Url): ID => {
-  const decoded = IDFromUrl.decode(url);
-
-  if (EI.isRight(decoded)) {
-    return decoded.right;
-  }
-
-  throw new Error(`Cannot decode ID from URL: ${url}.`);
-};

package/src/utils/etag.ts

@@ -1,11 +0,0 @@
-import { AxiosResponseHeaders } from 'axios';
-
-export type WithEtag<T> = T & { __etag__: string | undefined };
-
-export const getEtag = (object: WithEtag<unknown>) =>
-  object.__etag__?.substring(2);
-
-export const loadEtag = <T extends Record<string, unknown>>(response: {
-  data: T;
-  headers: AxiosResponseHeaders;
-}) => ({ ...response.data, __etag__: response.headers.etag });

package/src/utils/index.ts

@@ -1,19 +0,0 @@
-export * from './client';
-export * from './codecUtils.schema';
-export * from './codecUtils';
-export * from './etag';
-export * from './index';
-export * from './keyConvertor';
-export * from './listQuery.schema';
-export * from './listQuery';
-export * from './listResponse';
-export * from './pagination.schema';
-export * from './pagination';
-export * from './request';
-export * from './requestConfig';
-export * from './requestResponse';
-export * from './requestUtils';
-export * from './unpaginated';
-export * from './urlUtils';
-export * from './withFields';
-export * from './withSideload';