George Lambert
b4150c8250
Compose-ready workspace: packages/zappier (rate card, portal, Stripe), packages/verae-zapier-middleware (timestamp + NATS), packages/verae-zapier (CLI app), vendor/zapier-platform, and research/zapier vendor corpus. Gate 0 structure checks pass. Product code and research are not yet wired.
67 lines
2.4 KiB
JavaScript
67 lines
2.4 KiB
JavaScript
'use strict';
|
|
|
|
const makeSchema = require('../utils/makeSchema');
|
|
const { SKIP_KEY } = require('../constants');
|
|
|
|
const BasicOperationSchema = require('./BasicOperationSchema');
|
|
const FunctionSchema = require('./FunctionSchema');
|
|
const RequestSchema = require('./RequestSchema');
|
|
|
|
// TODO: would be nice to deep merge these instead
|
|
// or maybe use allOf which is built into json-schema
|
|
const BasicSearchOperationSchema = JSON.parse(
|
|
JSON.stringify(BasicOperationSchema.schema),
|
|
);
|
|
|
|
BasicSearchOperationSchema.id = '/BasicSearchOperationSchema';
|
|
BasicSearchOperationSchema.description =
|
|
'Represents the fundamental mechanics of a search.';
|
|
|
|
BasicSearchOperationSchema.properties = {
|
|
resource: BasicSearchOperationSchema.properties.resource,
|
|
perform: BasicSearchOperationSchema.properties.perform,
|
|
performResume: {
|
|
description:
|
|
'A function that parses data from a perform (which uses z.generateCallbackUrl()) and callback request to resume this action.',
|
|
$ref: FunctionSchema.id,
|
|
},
|
|
performGet: {
|
|
description:
|
|
'How will Zapier get a single record? If you find yourself reaching for this - consider resources and their built-in get methods.',
|
|
oneOf: [{ $ref: RequestSchema.id }, { $ref: FunctionSchema.id }],
|
|
},
|
|
canPaginate: {
|
|
description: 'Does this search support pagination?',
|
|
type: 'boolean',
|
|
},
|
|
inputFields: BasicSearchOperationSchema.properties.inputFields,
|
|
inputFieldGroups: BasicSearchOperationSchema.properties.inputFieldGroups,
|
|
outputFields: BasicSearchOperationSchema.properties.outputFields,
|
|
sample: BasicSearchOperationSchema.properties.sample,
|
|
lock: BasicSearchOperationSchema.properties.lock,
|
|
throttle: BasicSearchOperationSchema.properties.throttle,
|
|
cleanInputData: BasicSearchOperationSchema.properties.cleanInputData,
|
|
};
|
|
|
|
BasicSearchOperationSchema.examples = [
|
|
{
|
|
perform: { require: 'some/path/to/file.js' },
|
|
sample: { id: 42, name: 'Hooli' },
|
|
},
|
|
];
|
|
|
|
BasicSearchOperationSchema.antiExamples = [
|
|
{
|
|
[SKIP_KEY]: true, // Cannot validate that sample is only required if display isn't true / top-level resource doesn't have sample
|
|
example: {
|
|
perform: { require: 'some/path/to/file.js' },
|
|
},
|
|
reason:
|
|
'Missing required key: sample. Note - This is only invalid if `display` is not explicitly set to true and if it does not belong to a resource that has a sample.',
|
|
},
|
|
];
|
|
|
|
module.exports = makeSchema(
|
|
BasicSearchOperationSchema,
|
|
BasicOperationSchema.dependencies,
|
|
);
|