@rossum/api-client 0.1.24 → 0.1.25

package/src/utils/urlUtils.ts

@@ -1,23 +0,0 @@
-import { pipe } from 'fp-ts/lib/function';
-import { mapValues } from 'lodash/fp';
-import { stringify as _stringify, StringifyOptions } from 'query-string';
-
-const stringify =
-  (options: StringifyOptions) => (obj: { [key: string]: unknown }) =>
-    _stringify(obj, options);
-
-export const encodeObjectToQuery = (obj?: { [key: string]: unknown } | null) =>
-  pipe(
-    obj,
-    mapValues(value =>
-      typeof value === 'object' && value !== null && !Array.isArray(value)
-        ? JSON.stringify(value)
-        : value
-    ),
-    stringify({
-      arrayFormat: 'comma',
-      sort: false,
-      skipNull: true,
-      skipEmptyString: true,
-    })
-  );

package/src/utils/withFields.ts

@@ -1,53 +0,0 @@
-import { ZodArray, ZodObject, ZodRawShape, ZodType, ZodTypeAny, z } from 'zod';
-import { camelToSnake } from './keyConvertor';
-
-export const withFields = <
-  ResultsShape extends ZodRawShape,
-  PayloadShape extends ZodRawShape,
-  PaginationShape extends ZodRawShape,
-  Payload extends Record<string, unknown>,
-  Mask extends {
-    [k in keyof ResultsShape]?: true;
-  }
->(
-  obj: {
-    responseSchema: ZodObject<{
-      results: ZodArray<ZodObject<ResultsShape>>;
-      pagination: ZodObject<PaginationShape>;
-    }>;
-    querySchema: ZodType<unknown>;
-    query: Record<string, unknown>;
-
-    // All relevant props have to be included here to get forwarded properly.
-    // IDK how else to fix it.
-    endpoint: string;
-    payload: Payload;
-    payloadSchema: ZodObject<PayloadShape>;
-  },
-  mask: Mask
-) => {
-  const fields = Object.entries(mask)
-    .filter(([k, v]) => v === true)
-    .map(([k]) => camelToSnake(k));
-
-  const resultObject: ZodObject<ResultsShape> =
-    obj.responseSchema.shape.results.element;
-
-  return {
-    ...obj,
-    responseSchema: obj.responseSchema.omit({ results: true }).merge(
-      z.object({
-        results: z.array(resultObject.pick(mask)),
-      })
-    ),
-    querySchema: obj.querySchema.and(
-      z.object({
-        fields: z.array(z.string()),
-      })
-    ),
-    query: {
-      ...obj.query,
-      fields,
-    },
-  } as const;
-};

package/src/utils/withSideload.ts

@@ -1,39 +0,0 @@
-import { ZodObject, ZodRawShape, ZodType, z } from 'zod';
-import { camelToSnake } from './keyConvertor';
-
-export const withSideload = <
-  SideloadShape extends ZodRawShape,
-  ResponseShape extends ZodRawShape,
-  Mask extends {
-    [k in keyof SideloadShape]?: true;
-  }
->(
-  endpoint: {
-    sideloadSchema: ZodObject<SideloadShape>;
-    responseSchema: ZodObject<ResponseShape>;
-    querySchema: ZodType<unknown>;
-    endpoint: string;
-    query: Record<string, unknown>;
-  },
-  mask: Mask
-) => {
-  const sideload = Object.entries(mask)
-    .filter(([k, v]) => v === true)
-    .map(([k]) => camelToSnake(k));
-
-  return {
-    ...endpoint,
-    responseSchema: endpoint.responseSchema.and(
-      endpoint.sideloadSchema.pick(mask)
-    ),
-    querySchema: endpoint.querySchema.and(
-      z.object({
-        sideload: z.array(z.string()),
-      })
-    ),
-    query: {
-      ...endpoint.query,
-      sideload,
-    },
-  } as const;
-};

package/src/utils.schema.ts

@@ -1,8 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-const unknownKeysConfigSchema = z.union([
-  z.literal('passthrough'),
-  z.literal('strict'),
-  z.literal('strip'),
-]);

package/src/utils.ts

@@ -1,243 +0,0 @@
-/* eslint-disable guard-for-in */
-/* eslint-disable no-restricted-syntax */
-import * as D from 'io-ts/Decoder';
-import * as E from 'io-ts/Encoder';
-import { camelCase, mapKeys, snakeCase } from 'lodash';
-import {
-  z,
-  ZodArray,
-  ZodEffects,
-  ZodIntersection,
-  ZodNullable,
-  ZodObject,
-  ZodOptional,
-  ZodRecord,
-  ZodTuple,
-  ZodType,
-  ZodTypeDef,
-  ZodUnion,
-} from 'zod';
-
-type UnknownKeysConfig = 'passthrough' | 'strict' | 'strip';
-
-// TODO this should be overridable through env variable - for local development / tests we can use strict
-const globalUnknownKeysConfig: UnknownKeysConfig = 'passthrough';
-
-const camelCaseExcludeDots = (val: string) =>
-  val.split('.').map(camelCase).join('.');
-
-export const fromSnakeCase = (val: unknown) => {
-  if (typeof val === 'object' && val !== null) {
-    return mapKeys(val, (_, k) => camelCaseExcludeDots(k));
-  }
-  return val;
-};
-
-const snakeCaseExcludeDots = (val: string) =>
-  val.split('.').map(snakeCase).join('.');
-
-export const toSnakeCase = (val: unknown) => {
-  if (typeof val === 'object' && val !== null) {
-    return mapKeys(val, (_, k) => snakeCaseExcludeDots(k));
-  }
-  return val;
-};
-
-export const asResponseDecoder = <Out, Def extends ZodTypeDef, Input>(
-  schema: ZodType<Out, Def, Input>,
-  keyTransform: (val: unknown) => unknown = fromSnakeCase
-): D.Decoder<unknown, Out> => {
-  return {
-    decode: (backendResponse: unknown) => {
-      const parseResult = asResponseSchema(schema, keyTransform).safeParse(
-        backendResponse
-      );
-
-      if (parseResult.success === true) {
-        return D.success(parseResult.data);
-      }
-
-      // eslint-disable-next-line no-console
-      console.warn('An error has occured:');
-      // eslint-disable-next-line no-console
-      console.warn(parseResult.error);
-      return D.failure(backendResponse, parseResult.error.toString());
-    },
-  };
-};
-
-export const asPayloadEncoder = <Out, Def extends ZodTypeDef, Input>(
-  schema: ZodType<Out, Def, Input>,
-  keyTransform: (val: unknown) => unknown = toSnakeCase
-): any /* E.Encoder<Out, Out> */ => {
-  return E.contramap(req => asRequestSchema(schema, keyTransform).parse(req))(
-    E.id<Out>()
-  );
-};
-
-export const asQueryEncoder = <Out, Def extends ZodTypeDef, Input>(
-  schema: ZodType<Out, Def, Input>,
-  keyTransform: (val: unknown) => unknown = toSnakeCase
-): any /* E.Encoder<Out, Out> */ => {
-  return E.contramap(req => asRequestSchema(schema, keyTransform).parse(req))(
-    E.id<Out>()
-  );
-};
-
-// See test cases for detailed description why we need this.
-const convertIntersectionToObject = (
-  schema: ZodIntersection<any, any>
-): ZodObject<any> => {
-  const left =
-    schema._def.left instanceof ZodIntersection
-      ? convertIntersectionToObject(schema._def.left)
-      : schema._def.left;
-
-  const right =
-    schema._def.right instanceof ZodIntersection
-      ? convertIntersectionToObject(schema._def.right)
-      : schema._def.right;
-
-  if (!(left instanceof ZodObject) || !(right instanceof ZodObject)) {
-    throw new Error(
-      'Intersection types of non-objects are not supported. If you are creating an intersection type from a union `(A | B) & C`, rewrite it to `(A & C) | (B & C)`.'
-    );
-  }
-
-  return left.merge(right);
-};
-
-export const asResponseSchema = <Out, Def extends ZodTypeDef, Input>(
-  schema: ZodType<Out, Def, Input>,
-  keyTransform: (val: unknown) => unknown = fromSnakeCase,
-  unknownKeys: UnknownKeysConfig = globalUnknownKeysConfig
-): ZodType<Out, Def, Input> => {
-  if (schema instanceof ZodEffects) {
-    const originalEffect = schema._def.effect;
-
-    // for `transform` and `preprocess`, doesn't matter where we put the key conversion
-    // this doesn't handle `refinement` so we don't support it yet
-    const newEffect =
-      originalEffect.type === 'refinement'
-        ? originalEffect
-        : ({
-            ...originalEffect,
-            // transform: flow([originalEffect.transform, fromSnakeCase]),
-          } as any);
-
-    return ZodEffects.create(
-      asResponseSchema(schema._def.schema, keyTransform),
-      newEffect
-    ) as any;
-  }
-  if (schema instanceof ZodObject) {
-    const newShape: any = {};
-
-    for (const key in schema.shape) {
-      const fieldSchema = schema.shape[key];
-      newShape[key] = asResponseSchema(fieldSchema, keyTransform);
-    }
-    return z.preprocess(
-      fromSnakeCase,
-      new ZodObject({
-        ...schema._def,
-        shape: () => newShape,
-        unknownKeys,
-      })
-    ) as any;
-  }
-  if (schema instanceof ZodArray) {
-    return ZodArray.create(
-      asResponseSchema(schema.element, keyTransform)
-    ) as any;
-  }
-  // TODO this is a bug in ts-zod deepPartialify
-  if (schema instanceof ZodRecord) {
-    return ZodRecord.create(
-      asResponseSchema(schema.valueSchema, keyTransform)
-    ) as any;
-  }
-  if (schema instanceof ZodUnion) {
-    return ZodUnion.create(
-      schema.options.map((item: any) => asResponseSchema(item, keyTransform))
-    ) as any;
-  }
-  if (schema instanceof ZodIntersection) {
-    const converted = convertIntersectionToObject(schema);
-
-    return asResponseSchema(converted, keyTransform) as any;
-  }
-
-  if (schema instanceof ZodOptional) {
-    return ZodOptional.create(
-      asResponseSchema(schema.unwrap(), keyTransform)
-    ) as any;
-  }
-  if (schema instanceof ZodNullable) {
-    return ZodNullable.create(
-      asResponseSchema(schema.unwrap(), keyTransform)
-    ) as any;
-  }
-  if (schema instanceof ZodTuple) {
-    return ZodTuple.create(
-      schema.items.map((item: any) => asResponseSchema(item, keyTransform))
-    ) as any;
-  }
-  return schema;
-};
-
-export const asRequestSchema = <Out, Def extends ZodTypeDef, Input>(
-  schema: ZodType<Out, Def, Input>,
-  keyTransform: (val: unknown) => unknown = toSnakeCase
-): ZodType<Out, Def, Input> => {
-  if (schema instanceof ZodObject) {
-    const newShape: any = {};
-
-    for (const key in schema.shape) {
-      const fieldSchema = schema.shape[key];
-      newShape[key] = asRequestSchema(fieldSchema, keyTransform);
-    }
-    return new ZodObject({
-      ...schema._def,
-      shape: () => newShape,
-    }).transform(val => keyTransform(val)) as any;
-  }
-  if (schema instanceof ZodArray) {
-    return ZodArray.create(
-      asRequestSchema(schema.element, keyTransform)
-    ) as any;
-  }
-  // TODO this is a bug in ts-zod deepPartialify
-  if (schema instanceof ZodRecord) {
-    return ZodRecord.create(
-      asRequestSchema(schema.valueSchema, keyTransform)
-    ) as any;
-  }
-  if (schema instanceof ZodUnion) {
-    return ZodUnion.create(
-      schema.options.map((item: any) => asRequestSchema(item, keyTransform))
-    ) as any;
-  }
-  if (schema instanceof ZodIntersection) {
-    const converted = convertIntersectionToObject(schema);
-
-    return asRequestSchema(converted, keyTransform) as any;
-  }
-
-  if (schema instanceof ZodOptional) {
-    return ZodOptional.create(
-      asRequestSchema(schema.unwrap(), keyTransform)
-    ) as any;
-  }
-  if (schema instanceof ZodNullable) {
-    return ZodNullable.create(
-      asRequestSchema(schema.unwrap(), keyTransform)
-    ) as any;
-  }
-  if (schema instanceof ZodTuple) {
-    return ZodTuple.create(
-      schema.items.map((item: any) => asRequestSchema(item, keyTransform))
-    ) as any;
-  }
-  return schema;
-};

package/src/workflowActivities/endpoints/get.ts

@@ -1,14 +0,0 @@
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import {
-  WorkflowActivity,
-  WorkflowActivityUrl,
-} from '../models/workflowActivity';
-import { workflowActivitySchema } from '../models/workflowActivity.schema';
-
-export const get = (workflowActivityUrl: WorkflowActivityUrl) => {
-  return {
-    endpoint: workflowActivityUrl,
-    method: 'GET',
-    responseSchema: workflowActivitySchema,
-  } as const;
-};

package/src/workflowActivities/endpoints/index.ts

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

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

@@ -1,11 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { idSchema } from '../../utils/codecUtils.schema';
-import { paginationQuerySchema } from '../../utils/listQuery.schema';
-
-export const workflowActivitiesListQuerySchema = z
-  .object({
-    annotation: idSchema,
-  })
-  .partial()
-  .and(paginationQuerySchema);

package/src/workflowActivities/endpoints/list.ts

@@ -1,22 +0,0 @@
-import { ID } from '../../utils/codecUtils';
-import { PaginationQuery } from '../../utils/listQuery';
-import { ListResponse, listResponse } from '../../utils/listResponse';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { WorkflowActivity } from '../models';
-import { workflowActivitySchema } from '../models/workflowActivity.schema';
-import { workflowActivitiesListQuerySchema } from './list.schema';
-
-export type WorkflowActivitiesListQuery = Partial<{
-  annotation: ID;
-}> &
-  PaginationQuery;
-
-export const list = (query: WorkflowActivitiesListQuery = {}) => {
-  return {
-    endpoint: `/workflow_activities`,
-    method: 'GET',
-    responseSchema: listResponse(workflowActivitySchema),
-    query,
-    querySchema: workflowActivitiesListQuerySchema,
-  } as const;
-};

package/src/workflowActivities/index.ts

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

package/src/workflowActivities/models/index.ts

@@ -1 +0,0 @@
-export * from './workflowActivity';

package/src/workflowActivities/models/workflowActivity.schema.ts

@@ -1,33 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { idSchema, urlSchema } from '../../utils/codecUtils.schema';
-import { workflowUrlSchema } from '../../workflows/models/workflow.schema';
-import { workflowStepUrlSchema } from '../../workflowSteps/models/workflowStep.schema';
-
-export const workflowActivityUrlSchema = urlSchema;
-
-export const workflowActivityActionSchema = z.union([
-  z.literal('step_started'),
-  z.literal('step_completed'),
-  z.literal('approved'),
-  z.literal('rejected'),
-  z.literal('workflow_started'),
-  z.literal('reassigned'),
-  z.literal('workflow_completed'),
-  z.literal('pushed_back'),
-]);
-
-export const workflowActivitySchema = z.object({
-  id: idSchema,
-  url: workflowActivityUrlSchema,
-  organization: urlSchema,
-  annotation: urlSchema,
-  createdAt: z.string(),
-  createdBy: urlSchema.nullable(),
-  workflowRun: urlSchema.nullable(),
-  workflowStep: workflowStepUrlSchema.nullable(),
-  workflow: workflowUrlSchema.nullable(),
-  action: z.union([workflowActivityActionSchema, z.string()]),
-  note: z.string().nullable(),
-  assignees: z.array(urlSchema).nullable(),
-});

package/src/workflowActivities/models/workflowActivity.ts

@@ -1,30 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-import { WorkflowUrl } from '../../workflows/models/workflow';
-import { WorkflowStepUrl } from '../../workflowSteps/models/workflowStep';
-
-export type WorkflowActivityUrl = Url;
-export type WorkflowActivityAction =
-  | 'step_started'
-  | 'step_completed'
-  | 'approved'
-  | 'rejected'
-  | 'workflow_started'
-  | 'reassigned'
-  | 'workflow_completed'
-  | 'pushed_back';
-
-export type WorkflowActivity = {
-  id: ID;
-  url: WorkflowActivityUrl;
-  organization: Url;
-  annotation: Url;
-  createdAt: string;
-  createdBy: Url | null;
-  // Null if auto-rejected because no workflow can be found.
-  workflowRun: Url | null;
-  workflowStep: WorkflowStepUrl | null;
-  workflow: WorkflowUrl | null;
-  action: WorkflowActivityAction | string;
-  note: string | null;
-  assignees: Url[] | null;
-};

package/src/workflowRuns/endpoints/get.ts

@@ -1,11 +0,0 @@
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { WorkflowRun, WorkflowRunUrl } from '../models/workflowRun';
-import { workflowRunSchema } from '../models/workflowRun.schema';
-
-export const get = (workflowRunUrl: WorkflowRunUrl) => {
-  return {
-    endpoint: workflowRunUrl,
-    method: 'GET',
-    responseSchema: workflowRunSchema,
-  } as const;
-};

package/src/workflowRuns/endpoints/index.ts

@@ -1,10 +0,0 @@
-import { get } from './get';
-import { list } from './list';
-import { reset } from './reset';
-export { type WorkflowRunResetPayload } from './reset';
-
-export const workflowRuns = {
-  get,
-  list,
-  reset,
-};

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

@@ -1,13 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { idSchema } from '../../utils/codecUtils.schema';
-import { paginationQuerySchema } from '../../utils/listQuery.schema';
-import { workflowRunStatusSchema } from '../models/workflowRun.schema';
-
-export const workflowRunsListQuerySchema = z
-  .object({
-    annotation: z.union([idSchema, z.array(idSchema)]),
-    workflowStatus: workflowRunStatusSchema,
-  })
-  .partial()
-  .and(paginationQuerySchema);

package/src/workflowRuns/endpoints/list.ts

@@ -1,23 +0,0 @@
-import { ID } from '../../utils/codecUtils';
-import { PaginationQuery } from '../../utils/listQuery';
-import { ListResponse, listResponse } from '../../utils/listResponse';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { WorkflowRun, WorkflowRunStatus } from '../models/workflowRun';
-import { workflowRunSchema } from '../models/workflowRun.schema';
-import { workflowRunsListQuerySchema } from './list.schema';
-
-export type WorkflowRunsListQuery = Partial<{
-  annotation: ID | ID[];
-  workflowStatus: WorkflowRunStatus;
-}> &
-  PaginationQuery;
-
-export const list = (query: WorkflowRunsListQuery = {}) => {
-  return {
-    endpoint: `/workflow_runs`,
-    method: 'GET',
-    responseSchema: listResponse(workflowRunSchema),
-    query,
-    querySchema: workflowRunsListQuerySchema,
-  } as const;
-};

package/src/workflowRuns/endpoints/reset.schema.ts

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

package/src/workflowRuns/endpoints/reset.ts

@@ -1,20 +0,0 @@
-import { z } from 'zod';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { workflowRunResetPayloadSchema } from './reset.schema';
-
-export type WorkflowRunResetPayload = {
-  noteContent?: string;
-};
-
-export const reset = (
-  workflowRunId: number,
-  payload: WorkflowRunResetPayload
-) => {
-  return {
-    endpoint: `/workflow_runs/${workflowRunId}/reset`,
-    method: 'POST',
-    payload,
-    responseSchema: z.unknown(),
-    payloadSchema: workflowRunResetPayloadSchema,
-  } as const;
-};

package/src/workflowRuns/index.ts

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

package/src/workflowRuns/models/index.ts

@@ -1 +0,0 @@
-export * from './workflowRun';

package/src/workflowRuns/models/workflowRun.schema.ts

@@ -1,22 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { idSchema, urlSchema } from '../../utils/codecUtils.schema';
-import { workflowStepUrlSchema } from '../../workflowSteps/models/workflowStep.schema';
-
-export const workflowRunUrlSchema = urlSchema;
-
-export const workflowRunStatusSchema = z.union([
-  z.literal('pending'),
-  z.literal('approved'),
-  z.literal('rejected'),
-  z.literal('in_review'),
-]);
-
-export const workflowRunSchema = z.object({
-  id: idSchema,
-  url: workflowRunUrlSchema,
-  annotation: urlSchema,
-  currentStep: workflowStepUrlSchema.nullable(),
-  organization: urlSchema,
-  workflowStatus: workflowRunStatusSchema,
-});

package/src/workflowRuns/models/workflowRun.ts

@@ -1,18 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-import { WorkflowStepUrl } from '../../workflowSteps/models/workflowStep';
-
-export type WorkflowRunUrl = Url;
-export type WorkflowRunStatus =
-  | 'pending'
-  | 'approved'
-  | 'rejected'
-  | 'in_review';
-
-export type WorkflowRun = {
-  id: ID;
-  url: WorkflowRunUrl;
-  annotation: Url;
-  currentStep: WorkflowStepUrl | null;
-  organization: Url;
-  workflowStatus: WorkflowRunStatus;
-};

package/src/workflowSteps/endpoints/get.ts

@@ -1,11 +0,0 @@
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { WorkflowStep, WorkflowStepUrl } from '../models/workflowStep';
-import { workflowStepSchema } from '../models/workflowStep.schema';
-
-export const get = (workflowStepUrl: WorkflowStepUrl) => {
-  return {
-    endpoint: workflowStepUrl,
-    method: 'GET',
-    responseSchema: workflowStepSchema,
-  } as const;
-};

package/src/workflowSteps/endpoints/index.ts

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

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

@@ -1,12 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { idSchema } from '../../utils/codecUtils.schema';
-import { paginationQuerySchema } from '../../utils/listQuery.schema';
-
-export const workflowStepsListQuerySchema = z
-  .object({
-    workflow: idSchema,
-    id: z.union([idSchema, z.array(idSchema)]),
-  })
-  .partial()
-  .and(paginationQuerySchema);