@deliverart/sdk-js-integration 0.0.1

package/eslint.config.js

@@ -0,0 +1,37 @@
+/* eslint-disable */
+// eslint.config.js per @typescript-eslint v8
+import js from '@eslint/js'
+import prettier from 'eslint-config-prettier'
+import simpleImportSortPlugin from 'eslint-plugin-simple-import-sort'
+import tsPlugin from '@typescript-eslint/eslint-plugin'
+import tsParser from '@typescript-eslint/parser'
+
+export default [
+  js.configs.recommended,
+  {
+    files: ['**/*.ts'],
+    languageOptions: {
+      parser: tsParser,
+      globals: {
+        process: 'readonly',
+      },
+      parserOptions: {
+        project: ['./tsconfig.json'],
+        tsconfigRootDir: process.cwd(),
+        sourceType: 'module',
+      },
+    },
+    plugins: {
+      '@typescript-eslint': tsPlugin,
+      'simple-import-sort': simpleImportSortPlugin,
+    },
+    rules: {
+      'simple-import-sort/imports': 'error',
+      'simple-import-sort/exports': 'error',
+      '@typescript-eslint/no-unused-vars': 'warn',
+    },
+  },
+  prettier,
+]
+
+export const ignores = ['dist', 'node_modules']

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@deliverart/sdk-js-integration",
+  "description": "Deliverart JavaScript SDK for Integration Management",
+  "version": "0.0.1",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "dependencies": {
+    "@deliverart/sdk-js-core": "0.1.3",
+    "@deliverart/sdk-js-global-types": "0.0.15",
+    "@deliverart/sdk-js-point-of-sale": "0.0.6",
+    "@deliverart/sdk-js-sales-mode": "0.0.3",
+    "axios": "1.9.0",
+    "zod": "3.25.67"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.29.4",
+    "@eslint/js": "9.28.0",
+    "@types/node": "22.15.30",
+    "@typescript-eslint/eslint-plugin": "8.33.1",
+    "@typescript-eslint/parser": "8.33.1",
+    "eslint": "9.28.0",
+    "eslint-config-prettier": "10.1.5",
+    "eslint-plugin-simple-import-sort": "12.1.1",
+    "prettier": "3.5.3",
+    "tsup": "8.5.0",
+    "typescript": "5.8.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --dts --format esm,cjs",
+    "dev": "tsup src/index.ts --dts --watch",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "prettier": "prettier --check .",
+    "prettier:fix": "prettier --write .",
+    "version": "@changesets/cli version",
+    "release": "@changesets/cli publish"
+  }
+}

package/src/activatable-integration-data-schemas.ts

@@ -0,0 +1,50 @@
+import { z } from 'zod'
+
+import { integrationCassaInCloudDirectionSchema } from './types'
+
+export const integrationDeliverooDataSchema = z.object({
+  brandId: z.string(),
+  siteId: z.string(),
+  salesModeId: z.string().nullable(),
+})
+export type IntegrationDeliverooData = z.infer<typeof integrationDeliverooDataSchema>
+
+export const integrationGlovoDataSchema = z.object({
+  storeId: z.string(),
+  salesModeId: z.string().nullable(),
+})
+export type IntegrationGlovoData = z.infer<typeof integrationGlovoDataSchema>
+
+export const integrationJustEatDataSchema = z.object({
+  restaurantId: z.string(),
+  salesModeId: z.string().nullable(),
+})
+export type IntegrationJustEatData = z.infer<typeof integrationJustEatDataSchema>
+
+export const integrationCassaInCloudDataSchema = z.object({
+  apiKey: z.string(),
+  idSalesPoint: z.number(),
+  direction: integrationCassaInCloudDirectionSchema,
+  locale: z.string(),
+})
+export type IntegrationCassaInCloudData = z.infer<typeof integrationCassaInCloudDataSchema>
+
+export const integrationServiceDataSchema = z.discriminatedUnion('service', [
+  z.object({
+    service: z.literal('deliveroo'),
+    data: integrationDeliverooDataSchema,
+  }),
+  z.object({
+    service: z.literal('glovo'),
+    data: integrationGlovoDataSchema,
+  }),
+  z.object({
+    service: z.literal('justeat'),
+    data: integrationJustEatDataSchema,
+  }),
+  z.object({
+    service: z.literal('cassa_in_cloud'),
+    data: integrationCassaInCloudDataSchema,
+  }),
+])
+export type IntegrationServiceData = z.infer<typeof integrationServiceDataSchema>

package/src/activatable-integration-types.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod'
+
+export const activatableIntegrationStatuses = [
+  'waiting_for_user',
+  'waiting_for_admin',
+  'request_sent_partner',
+  'active',
+  'failed',
+] as const
+export const activatableIntegrationStatusSchema = z.enum(activatableIntegrationStatuses)
+export type ActivatableIntegrationStatus = z.infer<typeof activatableIntegrationStatusSchema>
+
+export const activatableIntegrationHealthStatuses = ['success', 'waiting', 'error'] as const
+export const activatableIntegrationHealthStatusSchema = z.enum(activatableIntegrationHealthStatuses)
+export type ActivatableIntegrationHealthStatus = z.infer<
+  typeof activatableIntegrationHealthStatusSchema
+>

package/src/activatable-integration.ts

@@ -0,0 +1,86 @@
+import { datetimeSchema } from '@deliverart/sdk-js-global-types'
+import { z } from 'zod'
+
+import {
+  integrationCassaInCloudDataSchema,
+  integrationDeliverooDataSchema,
+  integrationGlovoDataSchema,
+  integrationJustEatDataSchema,
+} from './activatable-integration-data-schemas'
+import {
+  activatableIntegrationHealthStatusSchema,
+  activatableIntegrationStatusSchema,
+} from './activatable-integration-types'
+import {
+  integrationCassaInCloudNullablePathSchema,
+  integrationCassaInCloudPathSchema,
+  integrationDeliverooNullablePathSchema,
+  integrationDeliverooPathSchema,
+  integrationGlovoNullablePathSchema,
+  integrationGlovoPathSchema,
+  integrationJustEatNullablePathSchema,
+  integrationJustEatPathSchema,
+  integrationProviderSchema,
+} from './types'
+
+export const activatableIntegrationBaseSchema = z.object({
+  id: z.string(),
+  connectionId: z.string().nullable(),
+  integration: z
+    .union([
+      integrationDeliverooPathSchema,
+      integrationGlovoPathSchema,
+      integrationJustEatPathSchema,
+      integrationCassaInCloudPathSchema,
+    ])
+    .nullable(),
+  status: activatableIntegrationStatusSchema,
+  healthStatus: activatableIntegrationHealthStatusSchema,
+  provider: integrationProviderSchema,
+  name: z.string(),
+  message: z.string().nullable(),
+  internalNotes: z.string().nullable(),
+  createdAt: datetimeSchema,
+  updatedAt: datetimeSchema,
+  updates: z.array(
+    z.object({
+      status: activatableIntegrationStatusSchema,
+      message: z.string(),
+      updatedAt: datetimeSchema,
+    }),
+  ),
+})
+
+function createIntegrationSchema<T extends string, D extends z.ZodTypeAny, I extends z.ZodTypeAny>(
+  service: T,
+  dataSchema: D,
+  integrationPathSchema: I,
+) {
+  return z
+    .object({
+      service: z.literal(service),
+      data: dataSchema,
+      integration: integrationPathSchema.nullable(),
+    })
+    .merge(activatableIntegrationBaseSchema.omit({ integration: true }))
+}
+
+export const activatableIntegrationSchema = z.discriminatedUnion('service', [
+  createIntegrationSchema(
+    'deliveroo',
+    integrationDeliverooDataSchema,
+    integrationDeliverooNullablePathSchema,
+  ),
+  createIntegrationSchema('glovo', integrationGlovoDataSchema, integrationGlovoNullablePathSchema),
+  createIntegrationSchema(
+    'justeat',
+    integrationJustEatDataSchema,
+    integrationJustEatNullablePathSchema,
+  ),
+  createIntegrationSchema(
+    'cassa_in_cloud',
+    integrationCassaInCloudDataSchema,
+    integrationCassaInCloudNullablePathSchema,
+  ),
+])
+export type ActivatableIntegration = z.infer<typeof activatableIntegrationSchema>

package/src/activation-request.ts

@@ -0,0 +1,53 @@
+import { pointOfSaleSchema } from '@deliverart/sdk-js-point-of-sale'
+import { z } from 'zod'
+
+import {
+  activatableIntegrationBaseSchema,
+  activatableIntegrationSchema,
+} from './activatable-integration'
+import {
+  integrationCassaInCloudDataSchema,
+  integrationDeliverooDataSchema,
+  integrationGlovoDataSchema,
+  integrationJustEatDataSchema,
+} from './activatable-integration-data-schemas'
+
+export const integrationActivationRequestSchema = activatableIntegrationSchema
+export type IntegrationActivationRequest = z.infer<typeof integrationActivationRequestSchema>
+
+export const integrationActivationRequestDetailsSchema = z.discriminatedUnion('service', [
+  z
+    .object({
+      pointOfSale: pointOfSaleSchema,
+      service: z.literal('deliveroo'),
+      data: integrationDeliverooDataSchema,
+    })
+    .merge(activatableIntegrationBaseSchema),
+
+  z
+    .object({
+      pointOfSale: pointOfSaleSchema,
+      service: z.literal('glovo'),
+      data: integrationGlovoDataSchema,
+    })
+    .merge(activatableIntegrationBaseSchema),
+
+  z
+    .object({
+      pointOfSale: pointOfSaleSchema,
+      service: z.literal('justeat'),
+      data: integrationJustEatDataSchema,
+    })
+    .merge(activatableIntegrationBaseSchema),
+
+  z
+    .object({
+      pointOfSale: pointOfSaleSchema,
+      service: z.literal('cassa_in_cloud'),
+      data: integrationCassaInCloudDataSchema,
+    })
+    .merge(activatableIntegrationBaseSchema),
+])
+export type IntegrationActivationRequestDetails = z.infer<
+  typeof integrationActivationRequestDetailsSchema
+>

package/src/cancellation-request-types.ts

@@ -0,0 +1,34 @@
+import { z } from 'zod'
+
+export const integrationCancellationRequestStatuses = ['pending', 'aborted', 'completed'] as const
+export const integrationCancellationRequestStatusSchema = z.enum(
+  integrationCancellationRequestStatuses,
+)
+export type IntegrationCancellationRequestStatus = z.infer<
+  typeof integrationCancellationRequestStatusSchema
+>
+
+export const integrationCancellationRequestPathSchema = z
+  .string()
+  .refine(val => /^\/integrations\/cancellation_requests\/[a-z_]+\/[0-9a-fA-F-]{36}$/.test(val), {
+    message: 'Invalid integration cancellation request path format',
+  })
+export type IntegrationCancellationRequestPath = z.infer<
+  typeof integrationCancellationRequestPathSchema
+>
+
+export const integrationCancellationRequestNullablePathSchema = z
+  .string()
+  .nullable()
+  .refine(
+    val => {
+      if (!val) return true
+      return /^\/integrations\/cancellation_requests\/[a-z_]+\/[0-9a-fA-F-]{36}$/.test(val)
+    },
+    {
+      message: 'Invalid integration cancellation request path format',
+    },
+  )
+export type IntegrationCancellationRequestNullablePath = z.infer<
+  typeof integrationCancellationRequestNullablePathSchema
+>

package/src/cancellation-request.ts

@@ -0,0 +1,21 @@
+import { datetimeSchema } from '@deliverart/sdk-js-global-types'
+import { z } from 'zod'
+
+import { integrationCancellationRequestStatusSchema } from './cancellation-request-types'
+import { integrationNullablePathSchema } from './types'
+
+export const integrationCancellationRequestSchema = z.object({
+  id: z.string(),
+  status: integrationCancellationRequestStatusSchema,
+  createdAt: datetimeSchema,
+  updatedAt: datetimeSchema,
+})
+export type IntegrationCancellationRequest = z.infer<typeof integrationCancellationRequestSchema>
+
+export const integrationCancellationRequestDetailsSchema =
+  integrationCancellationRequestSchema.extend({
+    integration: integrationNullablePathSchema,
+  })
+export type IntegrationCancellationRequestDetails = z.infer<
+  typeof integrationCancellationRequestDetailsSchema
+>

package/src/index.ts

@@ -0,0 +1,9 @@
+export * from './activatable-integration'
+export * from './activatable-integration-data-schemas'
+export * from './activatable-integration-types'
+export * from './activation-request'
+export * from './cancellation-request'
+export * from './cancellation-request-types'
+export * from './requests'
+export * from './schemas'
+export * from './types'

package/src/integration-schemas.ts

@@ -0,0 +1,31 @@
+import { z } from 'zod'
+
+import {
+  integrationCassaInCloudDetailsSchema,
+  integrationCassaInCloudSchema,
+} from './service-schemas/cassa_in_cloud'
+import {
+  integrationDeliverooDetailsSchema,
+  integrationDeliverooSchema,
+} from './service-schemas/deliveroo'
+import { integrationGlovoDetailsSchema, integrationGlovoSchema } from './service-schemas/glovo'
+import {
+  integrationJustEatDetailsSchema,
+  integrationJustEatSchema,
+} from './service-schemas/justeat'
+
+export const integrationSchema = z.discriminatedUnion('service', [
+  integrationJustEatSchema,
+  integrationDeliverooSchema,
+  integrationGlovoSchema,
+  integrationCassaInCloudSchema,
+])
+export type Integration = z.infer<typeof integrationSchema>
+
+export const integrationDetailsSchema = z.discriminatedUnion('service', [
+  integrationJustEatDetailsSchema,
+  integrationDeliverooDetailsSchema,
+  integrationGlovoDetailsSchema,
+  integrationCassaInCloudDetailsSchema,
+])
+export type IntegrationDetails = z.infer<typeof integrationDetailsSchema>

package/src/requests/DeleteIntegration.ts

@@ -0,0 +1,27 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { z } from 'zod'
+
+export const deleteIntegrationInputSchema = z.undefined()
+export const deleteIntegrationResponseSchema = z.undefined()
+
+export class DeleteIntegration extends AbstractApiRequest<void, void> {
+  readonly method = 'DELETE'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = deleteIntegrationInputSchema
+  readonly outputSchema = deleteIntegrationResponseSchema
+  readonly querySchema = undefined
+  readonly headersSchema = undefined
+
+  private readonly integrationId: string
+
+  constructor(integrationId: string) {
+    super()
+    this.integrationId = integrationId
+  }
+
+  getPath(): string {
+    return `/integrations/${this.integrationId}`
+  }
+}

package/src/requests/GetIntegrationDetails.ts

@@ -0,0 +1,30 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { z } from 'zod'
+
+import { IntegrationDetails, integrationDetailsSchema } from '../integration-schemas'
+
+export const getIntegrationDetailsInputSchema = z.undefined()
+
+export const getIntegrationDetailsResponseSchema = integrationDetailsSchema
+export type GetIntegrationDetailsResponse = IntegrationDetails
+
+export class GetIntegrationDetails extends AbstractApiRequest<void, GetIntegrationDetailsResponse> {
+  readonly method = 'GET'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+  readonly inputSchema = getIntegrationDetailsInputSchema
+  readonly outputSchema = getIntegrationDetailsResponseSchema
+  readonly querySchema = undefined
+  readonly headersSchema = undefined
+
+  private readonly integrationId: string
+
+  constructor(integrationId: string) {
+    super()
+    this.integrationId = integrationId
+  }
+
+  getPath(): string {
+    return `/integrations/${this.integrationId}`
+  }
+}

package/src/requests/GetIntegrations.ts

@@ -0,0 +1,63 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import {
+  createPaginatedSchema,
+  Paginated,
+  responseToPagination,
+  sortDirSchema,
+  timestampsFilterSchema,
+} from '@deliverart/sdk-js-global-types'
+import { AxiosResponse } from 'axios'
+import { z } from 'zod'
+
+import { Integration, integrationSchema } from '../integration-schemas'
+import { integrationServiceSchema, integrationStatusSchema } from '../types'
+
+export const getIntegrationsQuerySchema = z
+  .object({
+    status: integrationStatusSchema.optional(),
+    'status[]': z.array(integrationStatusSchema).optional(),
+    connectionId: z.string().optional(),
+    'connectionId[]': z.array(z.string()).optional(),
+    service: integrationServiceSchema.optional(),
+    'order[createdAt]': sortDirSchema.optional(),
+    'order[updatedAt]': sortDirSchema.optional(),
+    page: z.coerce.number().optional(),
+  })
+  .merge(timestampsFilterSchema)
+export type GetIntegrationsQueryParams = z.infer<typeof getIntegrationsQuerySchema>
+
+export const getIntegrationsResponseSchema = createPaginatedSchema(integrationSchema)
+export type GetIntegrationsResponse = z.infer<typeof getIntegrationsResponseSchema>
+
+export const getIntegrationsInputSchema = z.undefined()
+
+export class GetIntegrations extends AbstractApiRequest<
+  void,
+  GetIntegrationsResponse,
+  GetIntegrationsQueryParams
+> {
+  readonly method = 'GET'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = getIntegrationsInputSchema
+  readonly outputSchema = getIntegrationsResponseSchema
+  readonly querySchema = getIntegrationsQuerySchema
+  readonly headersSchema = undefined
+
+  constructor(options?: { query?: GetIntegrationsQueryParams }) {
+    super(undefined, options)
+  }
+
+  getPath(): string {
+    return '/integrations'
+  }
+
+  parseResponse(data: unknown, rawResponse: AxiosResponse): Paginated<Integration> {
+    const integrations = z.array(integrationSchema).parse(data)
+    return this.validateOutput({
+      data: integrations,
+      pagination: responseToPagination(rawResponse),
+    })
+  }
+}

package/src/requests/UpdateIntegration.ts

@@ -0,0 +1,36 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { z } from 'zod'
+
+import { IntegrationDetails, integrationDetailsSchema } from '../integration-schemas'
+import { writableIntegrationSchema } from '../schemas'
+
+export const updateIntegrationInputSchema = writableIntegrationSchema.partial()
+export type UpdateIntegrationInput = z.infer<typeof updateIntegrationInputSchema>
+
+export const updateIntegrationResponseSchema = integrationDetailsSchema
+export type UpdateIntegrationResponse = IntegrationDetails
+
+export class UpdateIntegration extends AbstractApiRequest<
+  UpdateIntegrationInput,
+  UpdateIntegrationResponse
+> {
+  readonly method = 'PATCH'
+  readonly contentType = 'application/merge-patch+json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = updateIntegrationInputSchema
+  readonly outputSchema = updateIntegrationResponseSchema
+  readonly querySchema = undefined
+  readonly headersSchema = undefined
+
+  private readonly integrationId: string
+
+  constructor(integrationId: string, input: UpdateIntegrationInput) {
+    super(input)
+    this.integrationId = integrationId
+  }
+
+  getPath(): string {
+    return `/integrations/${this.integrationId}`
+  }
+}

package/src/requests/activation-requests/ActivateIntegrationActivationRequest.ts

@@ -0,0 +1,38 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { z } from 'zod'
+
+import {
+  IntegrationActivationRequestDetails,
+  integrationActivationRequestDetailsSchema,
+} from '../../activation-request'
+
+export const activateIntegrationActivationRequestInputSchema = z.undefined()
+
+export const activateIntegrationActivationRequestResponseSchema =
+  integrationActivationRequestDetailsSchema
+export type ActivateIntegrationActivationRequestResponse = IntegrationActivationRequestDetails
+
+export class ActivateIntegrationActivationRequest extends AbstractApiRequest<
+  void,
+  ActivateIntegrationActivationRequestResponse
+> {
+  readonly method = 'POST'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = activateIntegrationActivationRequestInputSchema
+  readonly outputSchema = activateIntegrationActivationRequestResponseSchema
+  readonly querySchema = undefined
+  readonly headersSchema = undefined
+
+  private readonly integrationActivationRequestId: string
+
+  constructor(integrationActivationRequestId: string) {
+    super()
+    this.integrationActivationRequestId = integrationActivationRequestId
+  }
+
+  getPath(): string {
+    return `/integrations/activation_requests/${this.integrationActivationRequestId}/send-partner`
+  }
+}

package/src/requests/activation-requests/AnnotateIntegrationActivationRequest.ts

@@ -0,0 +1,46 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { z } from 'zod'
+
+import {
+  IntegrationActivationRequestDetails,
+  integrationActivationRequestDetailsSchema,
+} from '../../activation-request'
+
+export const annotateIntegrationActivationRequestInputSchema = z.object({
+  message: z.string().min(1, 'Message is required'),
+})
+export type AnnotateIntegrationActivationRequestInput = z.infer<
+  typeof annotateIntegrationActivationRequestInputSchema
+>
+
+export const annotateIntegrationActivationRequestResponseSchema =
+  integrationActivationRequestDetailsSchema
+export type AnnotateIntegrationActivationRequestResponse = IntegrationActivationRequestDetails
+
+export class AnnotateIntegrationActivationRequest extends AbstractApiRequest<
+  AnnotateIntegrationActivationRequestInput,
+  AnnotateIntegrationActivationRequestResponse
+> {
+  readonly method = 'POST'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = annotateIntegrationActivationRequestInputSchema
+  readonly outputSchema = annotateIntegrationActivationRequestResponseSchema
+  readonly querySchema = undefined
+  readonly headersSchema = undefined
+
+  private readonly integrationActivationRequestId: string
+
+  constructor(
+    integrationActivationRequestId: string,
+    input: AnnotateIntegrationActivationRequestInput,
+  ) {
+    super(input)
+    this.integrationActivationRequestId = integrationActivationRequestId
+  }
+
+  getPath(): string {
+    return `/integrations/activation_requests/${this.integrationActivationRequestId}/annotate`
+  }
+}