Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[wip don't review] Hooks/improved types #2015

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions packages/core/src/destination-kit/action.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,14 @@ import { InputData, Features, transform, transformBatch } from '../mapping-kit'
import { fieldsToJsonSchema } from './fields-to-jsonschema'
import { Response } from '../fetch'
import type { ModifiedResponse } from '../types'
import type { DynamicFieldResponse, InputField, RequestExtension, ExecuteInput, Result } from './types'
import type {
DynamicFieldResponse,
InputField,
RequestExtension,
ExecuteInput,
ExecuteHookInput,
Result
} from './types'
import { NormalizedOptions } from '../request-client'
import type { JSONSchema4 } from 'json-schema'
import { validateSchema } from '../schema-validation'
Expand All @@ -23,6 +30,11 @@ export type RequestFn<Settings, Payload, Return = any, AudienceSettings = any, A
data: ExecuteInput<Settings, Payload, AudienceSettings, ActionHookInputs>
) => MaybePromise<Return>

export type HookRequestFn<Settings, Payload, Return = any, AudienceSettings = any, ActionHookInputs = any> = (
request: RequestClient,
data: ExecuteHookInput<Settings, Payload, AudienceSettings, ActionHookInputs>
) => MaybePromise<Return>

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export interface BaseActionDefinition {
/** The display title of the action */
Expand Down Expand Up @@ -134,7 +146,7 @@ export interface ActionHookDefinition<
/** The shape of the return from performHook. These values will be available in the generated-types: Payload for use in perform() */
outputTypes?: Record<string, { label: string; description: string; type: string; required: boolean }>
/** The operation to perform when this hook is triggered. */
performHook: RequestFn<
performHook: HookRequestFn<
Settings,
Payload,
ActionHookResponse<GeneratedActionHookOutputs>,
Expand Down Expand Up @@ -385,7 +397,7 @@ export class Action<Settings, Payload extends JSONLikeObject, AudienceSettings =

async executeHook(
hookType: ActionHookType,
data: ExecuteInput<Settings, Payload, AudienceSettings>
data: ExecuteHookInput<Settings, Payload, AudienceSettings>
): Promise<ActionHookResponse<any>> {
if (!this.hasHookSupport) {
throw new IntegrationError('This action does not support any hooks.', 'NotImplemented', 501)
Expand All @@ -401,9 +413,17 @@ export class Action<Settings, Payload extends JSONLikeObject, AudienceSettings =
validateSchema(data.hookInputs, schema)
}

return (await this.performRequest(hookFn, data)) as ActionHookResponse<any>
return (await this.performHookRequest(hookFn, data)) as ActionHookResponse<any>
}

private async performHookRequest<T extends Payload>(
requestFn: HookRequestFn<Settings, T, any, AudienceSettings>,
data: ExecuteHookInput<Settings, T, AudienceSettings>
): Promise<unknown> {
const requestClient = this.createRequestClient(data as ExecuteInput<Settings, T>)
const response = await requestFn(requestClient, data)
return this.parseResponse(response)
}
/**
* Perform a request using the definition's request client
* the given request function
Expand Down
14 changes: 14 additions & 0 deletions packages/core/src/destination-kit/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,20 @@ export interface Result {
data?: JSONObject | null
}

type RawMapping<Payload> = Record<keyof Payload, FieldValue>
export interface ExecuteHookInput<
Settings,
Payload,
AudienceSettings = unknown,
ActionHookInputs = any,
ActionHookOutputs = any
> extends Omit<
ExecuteInput<Settings, Payload, AudienceSettings, ActionHookInputs, ActionHookOutputs>,
'payload' | 'mapping'
> {
readonly mapping?: RawMapping<Payload>
}

export interface ExecuteInput<
Settings,
Payload,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,13 @@ const action: ActionDefinition<Settings, Payload, undefined, HookBundle> = {
required: true
}
},
performHook: async (request, { hookInputs, hookOutputs }) => {
performHook: async (request, { hookInputs, hookOutputs, mapping }) => {
const linkedIn = new LinkedInConversions(request)
const test = mapping?.acxiomID

if (test) {
console.log('test', test)
}

let hookReturn: ActionHookResponse<HookBundle['onMappingSave']['outputs']>
if (hookOutputs?.onMappingSave?.outputs) {
Expand Down
Loading