@membranehq/sdk 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +32 -0
- package/dist/bundle.d.ts +2543 -0
- package/dist/bundle.js +26089 -0
- package/dist/bundle.js.map +1 -0
- package/dist/dts/__mocks__/axios.d.ts +4 -0
- package/dist/dts/_helper.d.ts +7 -0
- package/dist/dts/_helper.test.d.ts +1 -0
- package/dist/dts/accessors.d.ts +85 -0
- package/dist/dts/accessors.test.d.ts +1 -0
- package/dist/dts/actions/accessors.d.ts +49 -0
- package/dist/dts/actions/action-types.d.ts +26 -0
- package/dist/dts/actions/index.d.ts +3 -0
- package/dist/dts/actions/types.d.ts +95 -0
- package/dist/dts/alerts/index.d.ts +1 -0
- package/dist/dts/alerts/types.d.ts +24 -0
- package/dist/dts/api-client.d.ts +32 -0
- package/dist/dts/api-client.test.d.ts +1 -0
- package/dist/dts/app-data-schemas/accessors.d.ts +18 -0
- package/dist/dts/app-data-schemas/api.d.ts +33 -0
- package/dist/dts/app-data-schemas/index.d.ts +23 -0
- package/dist/dts/app-events/accessors.d.ts +20 -0
- package/dist/dts/app-events/api.d.ts +44 -0
- package/dist/dts/app-events/index.d.ts +42 -0
- package/dist/dts/apps/index.d.ts +1 -0
- package/dist/dts/apps/types.d.ts +18 -0
- package/dist/dts/auth/accessors.d.ts +10 -0
- package/dist/dts/auth/index.d.ts +7 -0
- package/dist/dts/client.d.ts +70 -0
- package/dist/dts/connections/accessors.d.ts +88 -0
- package/dist/dts/connections/api.d.ts +27 -0
- package/dist/dts/connections/create-or-update-connection.d.ts +14 -0
- package/dist/dts/connections/index.d.ts +3 -0
- package/dist/dts/connections/types.d.ts +52 -0
- package/dist/dts/connector-copilot/index.d.ts +1 -0
- package/dist/dts/connector-copilot/types.d.ts +160 -0
- package/dist/dts/connectors/auth.d.ts +171 -0
- package/dist/dts/connectors/constants.d.ts +5 -0
- package/dist/dts/connectors/data-locations/base.d.ts +10 -0
- package/dist/dts/connectors/data-locations/collections/events/implementation-types/connector-event.d.ts +14 -0
- package/dist/dts/connectors/data-locations/collections/events/implementation-types/custom-pull.d.ts +14 -0
- package/dist/dts/connectors/data-locations/collections/events/implementation-types/full-scan.d.ts +7 -0
- package/dist/dts/connectors/data-locations/collections/events/implementation-types/pull-latest-records.d.ts +17 -0
- package/dist/dts/connectors/data-locations/collections/events/implementation-types/webhook.d.ts +18 -0
- package/dist/dts/connectors/data-locations/collections/events/index.d.ts +50 -0
- package/dist/dts/connectors/data-locations/collections/events/methods.d.ts +15 -0
- package/dist/dts/connectors/data-locations/collections/index.d.ts +70 -0
- package/dist/dts/connectors/data-locations/collections/methods/base.d.ts +24 -0
- package/dist/dts/connectors/data-locations/collections/methods/create.d.ts +7 -0
- package/dist/dts/connectors/data-locations/collections/methods/delete.d.ts +2 -0
- package/dist/dts/connectors/data-locations/collections/methods/find-by-id.d.ts +2 -0
- package/dist/dts/connectors/data-locations/collections/methods/find.d.ts +6 -0
- package/dist/dts/connectors/data-locations/collections/methods/list.d.ts +5 -0
- package/dist/dts/connectors/data-locations/collections/methods/match.d.ts +5 -0
- package/dist/dts/connectors/data-locations/collections/methods/search.d.ts +2 -0
- package/dist/dts/connectors/data-locations/collections/methods/update.d.ts +6 -0
- package/dist/dts/connectors/data-locations/directories/index.d.ts +17 -0
- package/dist/dts/connectors/data-locations/directories/methods/base.d.ts +18 -0
- package/dist/dts/connectors/data-locations/directories/methods/list.d.ts +2 -0
- package/dist/dts/connectors/data-locations/index.d.ts +6 -0
- package/dist/dts/connectors/data-locations/methods.d.ts +6 -0
- package/dist/dts/connectors/data-locations/types.d.ts +258 -0
- package/dist/dts/connectors/data-locations/utils.d.ts +17 -0
- package/dist/dts/connectors/data-locations/utils.test.d.ts +1 -0
- package/dist/dts/connectors/data-records.d.ts +7 -0
- package/dist/dts/connectors/events/index.d.ts +1 -0
- package/dist/dts/connectors/events/types.d.ts +36 -0
- package/dist/dts/connectors/global-webhooks/index.d.ts +1 -0
- package/dist/dts/connectors/global-webhooks/types.d.ts +33 -0
- package/dist/dts/connectors/graphql-api.d.ts +17 -0
- package/dist/dts/connectors/index.d.ts +13 -0
- package/dist/dts/connectors/methods.d.ts +44 -0
- package/dist/dts/connectors/openapi.d.ts +11 -0
- package/dist/dts/connectors/operations/handlers.d.ts +9 -0
- package/dist/dts/connectors/operations/index.d.ts +2 -0
- package/dist/dts/connectors/operations/types.d.ts +26 -0
- package/dist/dts/connectors/rest-api.d.ts +67 -0
- package/dist/dts/connectors/types.d.ts +75 -0
- package/dist/dts/connectors/udm.d.ts +14 -0
- package/dist/dts/data-builder/formula-processors.d.ts +13 -0
- package/dist/dts/data-builder/formula-processors.test.d.ts +1 -0
- package/dist/dts/data-builder/formula-types.d.ts +4 -0
- package/dist/dts/data-builder/formulas/and.d.ts +9 -0
- package/dist/dts/data-builder/formulas/and.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/base.d.ts +47 -0
- package/dist/dts/data-builder/formulas/case.d.ts +18 -0
- package/dist/dts/data-builder/formulas/case.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/concat.d.ts +19 -0
- package/dist/dts/data-builder/formulas/concat.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/copy.d.ts +10 -0
- package/dist/dts/data-builder/formulas/copy.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/dataSchemaRef.d.ts +22 -0
- package/dist/dts/data-builder/formulas/dataSchemaRef.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/domainFromEmail.d.ts +10 -0
- package/dist/dts/data-builder/formulas/domainFromEmail.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/eval.d.ts +28 -0
- package/dist/dts/data-builder/formulas/eval.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/extractDate.d.ts +11 -0
- package/dist/dts/data-builder/formulas/extractDate.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/extractTime.d.ts +11 -0
- package/dist/dts/data-builder/formulas/extractTime.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/findAppRecordId.d.ts +17 -0
- package/dist/dts/data-builder/formulas/findAppRecordId.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/findExternalRecordId.d.ts +17 -0
- package/dist/dts/data-builder/formulas/findExternalRecordId.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/first-name.d.ts +10 -0
- package/dist/dts/data-builder/formulas/first-name.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/firstNotEmpty.d.ts +7 -0
- package/dist/dts/data-builder/formulas/firstNotEmpty.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/formula.d.ts +8 -0
- package/dist/dts/data-builder/formulas/formula.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/index.d.ts +26 -0
- package/dist/dts/data-builder/formulas/index.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/iterate.d.ts +19 -0
- package/dist/dts/data-builder/formulas/iterate.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/jsonata.d.ts +8 -0
- package/dist/dts/data-builder/formulas/jsonata.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/last-name.d.ts +11 -0
- package/dist/dts/data-builder/formulas/last-name.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/lookup.d.ts +12 -0
- package/dist/dts/data-builder/formulas/lookup.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/map.d.ts +17 -0
- package/dist/dts/data-builder/formulas/map.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/mergeObjects.d.ts +12 -0
- package/dist/dts/data-builder/formulas/mergeObjects.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/or.d.ts +9 -0
- package/dist/dts/data-builder/formulas/or.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/plain.d.ts +8 -0
- package/dist/dts/data-builder/formulas/plain.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/record.d.ts +11 -0
- package/dist/dts/data-builder/formulas/record.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/tpl.d.ts +15 -0
- package/dist/dts/data-builder/formulas/tpl.test.d.ts +1 -0
- package/dist/dts/data-builder/formulas/types.d.ts +27 -0
- package/dist/dts/data-builder/formulas/var.d.ts +11 -0
- package/dist/dts/data-builder/formulas/var.test.d.ts +1 -0
- package/dist/dts/data-builder/index.d.ts +9 -0
- package/dist/dts/data-builder/index.test.d.ts +1 -0
- package/dist/dts/data-builder/locators.d.ts +44 -0
- package/dist/dts/data-builder/locators.test.d.ts +1 -0
- package/dist/dts/data-collections/index.d.ts +1 -0
- package/dist/dts/data-collections/types.d.ts +24 -0
- package/dist/dts/data-filter/index.d.ts +13 -0
- package/dist/dts/data-filter/index.test.d.ts +1 -0
- package/dist/dts/data-filter/operators.d.ts +13 -0
- package/dist/dts/data-filter/operators.test.d.ts +1 -0
- package/dist/dts/data-form/data-field.d.ts +7 -0
- package/dist/dts/data-form/index.d.ts +21 -0
- package/dist/dts/data-links/accessors.d.ts +20 -0
- package/dist/dts/data-links/api.d.ts +56 -0
- package/dist/dts/data-links/index.d.ts +36 -0
- package/dist/dts/data-schema/create.d.ts +2 -0
- package/dist/dts/data-schema/create.test.d.ts +1 -0
- package/dist/dts/data-schema/data-field.d.ts +14 -0
- package/dist/dts/data-schema/index.d.ts +5 -0
- package/dist/dts/data-schema/merge.d.ts +10 -0
- package/dist/dts/data-schema/merge.test.d.ts +1 -0
- package/dist/dts/data-schema/types.d.ts +35 -0
- package/dist/dts/data-schema/utils.d.ts +47 -0
- package/dist/dts/data-schema/utils.test.d.ts +1 -0
- package/dist/dts/data-sources/accessors.d.ts +64 -0
- package/dist/dts/data-sources/api.d.ts +90 -0
- package/dist/dts/data-sources/constants.d.ts +4 -0
- package/dist/dts/data-sources/index.d.ts +4 -0
- package/dist/dts/data-sources/types.d.ts +63 -0
- package/dist/dts/date-time/index.d.ts +1 -0
- package/dist/dts/date-time/parse.d.ts +1 -0
- package/dist/dts/date-time/parse.test.d.ts +1 -0
- package/dist/dts/datetime.d.ts +1 -0
- package/dist/dts/entity-repository.d.ts +24 -0
- package/dist/dts/errors/error-doc-enum.d.ts +7 -0
- package/dist/dts/errors/index.d.ts +105 -0
- package/dist/dts/external-events/accessors.d.ts +19 -0
- package/dist/dts/external-events/api.d.ts +22 -0
- package/dist/dts/external-events/index.d.ts +8 -0
- package/dist/dts/external-events/types.d.ts +157 -0
- package/dist/dts/field-mappings/accessors.d.ts +54 -0
- package/dist/dts/field-mappings/api.d.ts +58 -0
- package/dist/dts/field-mappings/index.d.ts +66 -0
- package/dist/dts/field-mappings/merge/is-object.test.d.ts +1 -0
- package/dist/dts/field-mappings/merge/merge-with-formulas.d.ts +2 -0
- package/dist/dts/field-mappings/merge/merge-with-formulas.test.d.ts +1 -0
- package/dist/dts/field-mappings/types.d.ts +12 -0
- package/dist/dts/flow-runs/accessors.d.ts +33 -0
- package/dist/dts/flow-runs/flow-node-runs.d.ts +42 -0
- package/dist/dts/flow-runs/index.d.ts +78 -0
- package/dist/dts/flows/accessors.d.ts +75 -0
- package/dist/dts/flows/api.d.ts +54 -0
- package/dist/dts/flows/index.d.ts +6 -0
- package/dist/dts/flows/nodes/api-request-to-external-app.d.ts +3 -0
- package/dist/dts/flows/nodes/api-request-to-your-app.d.ts +3 -0
- package/dist/dts/flows/nodes/api-trigger.d.ts +3 -0
- package/dist/dts/flows/nodes/app-event-trigger.d.ts +3 -0
- package/dist/dts/flows/nodes/base.d.ts +17 -0
- package/dist/dts/flows/nodes/connector-event-trigger.d.ts +3 -0
- package/dist/dts/flows/nodes/create-data-link.d.ts +3 -0
- package/dist/dts/flows/nodes/create-data-record.d.ts +3 -0
- package/dist/dts/flows/nodes/custom-http-request.d.ts +3 -0
- package/dist/dts/flows/nodes/data-record-created-trigger.d.ts +3 -0
- package/dist/dts/flows/nodes/data-record-deleted-trigger.d.ts +3 -0
- package/dist/dts/flows/nodes/data-record-updated-trigger.d.ts +3 -0
- package/dist/dts/flows/nodes/delete-data-link.d.ts +3 -0
- package/dist/dts/flows/nodes/delete-data-record.d.ts +3 -0
- package/dist/dts/flows/nodes/filter.d.ts +3 -0
- package/dist/dts/flows/nodes/find-data-link.d.ts +3 -0
- package/dist/dts/flows/nodes/find-data-record-by-id.d.ts +3 -0
- package/dist/dts/flows/nodes/find-data-records.d.ts +3 -0
- package/dist/dts/flows/nodes/find-or-create-data-record.d.ts +3 -0
- package/dist/dts/flows/nodes/for-each-v2.d.ts +3 -0
- package/dist/dts/flows/nodes/for-each.d.ts +3 -0
- package/dist/dts/flows/nodes/index.d.ts +37 -0
- package/dist/dts/flows/nodes/integration-specific-operation.d.ts +3 -0
- package/dist/dts/flows/nodes/list-data-records.d.ts +3 -0
- package/dist/dts/flows/nodes/lookup-data-record.d.ts +3 -0
- package/dist/dts/flows/nodes/run-action.d.ts +3 -0
- package/dist/dts/flows/nodes/run-javascript.d.ts +3 -0
- package/dist/dts/flows/nodes/schedule-trigger.d.ts +3 -0
- package/dist/dts/flows/nodes/search-data-records.d.ts +3 -0
- package/dist/dts/flows/nodes/transform-data.d.ts +3 -0
- package/dist/dts/flows/nodes/update-data-record.d.ts +3 -0
- package/dist/dts/flows/schemas.d.ts +240 -0
- package/dist/dts/flows/types.d.ts +77 -0
- package/dist/dts/flows/utils.d.ts +16 -0
- package/dist/dts/flows/utils.test.d.ts +1 -0
- package/dist/dts/http-requests.d.ts +37 -0
- package/dist/dts/iframe.d.ts +11 -0
- package/dist/dts/index.d.ts +41 -0
- package/dist/dts/index.umd.d.ts +2 -0
- package/dist/dts/integration-elements/common.d.ts +3 -0
- package/dist/dts/integration-elements/connection-level-element.accessor.d.ts +29 -0
- package/dist/dts/integration-elements/index.d.ts +74 -0
- package/dist/dts/integration-elements/integration-level-element.accessor.d.ts +25 -0
- package/dist/dts/integrations/accessors.d.ts +58 -0
- package/dist/dts/integrations/api.d.ts +23 -0
- package/dist/dts/integrations/index.d.ts +3 -0
- package/dist/dts/integrations/types.d.ts +38 -0
- package/dist/dts/jwt.d.ts +1 -0
- package/dist/dts/jwt.test.d.ts +1 -0
- package/dist/dts/logging/index.d.ts +8 -0
- package/dist/dts/logging/index.test.d.ts +1 -0
- package/dist/dts/logging/types.d.ts +13 -0
- package/dist/dts/orgs/index.d.ts +1 -0
- package/dist/dts/orgs/types.d.ts +59 -0
- package/dist/dts/scenarios/accessors.d.ts +9 -0
- package/dist/dts/scenarios/index.d.ts +2 -0
- package/dist/dts/scenarios/types.d.ts +145 -0
- package/dist/dts/screens/accessors.d.ts +9 -0
- package/dist/dts/screens/index.d.ts +2 -0
- package/dist/dts/screens/types.d.ts +37 -0
- package/dist/dts/udm/activities.d.ts +143 -0
- package/dist/dts/udm/activities.test.d.ts +1 -0
- package/dist/dts/udm/base.d.ts +62 -0
- package/dist/dts/udm/bills.d.ts +3 -0
- package/dist/dts/udm/campaign-members.d.ts +3 -0
- package/dist/dts/udm/campaigns.d.ts +3 -0
- package/dist/dts/udm/companies.d.ts +3 -0
- package/dist/dts/udm/contact-lists.d.ts +3 -0
- package/dist/dts/udm/contacts.d.ts +3 -0
- package/dist/dts/udm/credit-notes.d.ts +3 -0
- package/dist/dts/udm/customers.d.ts +3 -0
- package/dist/dts/udm/deal-products.d.ts +3 -0
- package/dist/dts/udm/deal-stages.d.ts +3 -0
- package/dist/dts/udm/deals.d.ts +3 -0
- package/dist/dts/udm/documents.d.ts +59 -0
- package/dist/dts/udm/drive-items.d.ts +78 -0
- package/dist/dts/udm/drives.d.ts +46 -0
- package/dist/dts/udm/eeocs.d.ts +3 -0
- package/dist/dts/udm/emails.d.ts +115 -0
- package/dist/dts/udm/employees.d.ts +3 -0
- package/dist/dts/udm/files.d.ts +73 -0
- package/dist/dts/udm/folders.d.ts +66 -0
- package/dist/dts/udm/index.d.ts +53 -0
- package/dist/dts/udm/invoices.d.ts +3 -0
- package/dist/dts/udm/job-applications.d.ts +3 -0
- package/dist/dts/udm/job-candidates.d.ts +3 -0
- package/dist/dts/udm/job-interviews.d.ts +3 -0
- package/dist/dts/udm/job-offers.d.ts +3 -0
- package/dist/dts/udm/jobs.d.ts +3 -0
- package/dist/dts/udm/journal-entries.d.ts +3 -0
- package/dist/dts/udm/leads.d.ts +3 -0
- package/dist/dts/udm/ledger-accounts.d.ts +3 -0
- package/dist/dts/udm/meetings.d.ts +98 -0
- package/dist/dts/udm/messages.d.ts +51 -0
- package/dist/dts/udm/notes.d.ts +61 -0
- package/dist/dts/udm/orders.d.ts +3 -0
- package/dist/dts/udm/payments.d.ts +3 -0
- package/dist/dts/udm/payrolls.d.ts +3 -0
- package/dist/dts/udm/products.d.ts +3 -0
- package/dist/dts/udm/projects.d.ts +3 -0
- package/dist/dts/udm/suppliers.d.ts +3 -0
- package/dist/dts/udm/tasks.d.ts +104 -0
- package/dist/dts/udm/tax-rates.d.ts +3 -0
- package/dist/dts/udm/timeoff-balances.d.ts +3 -0
- package/dist/dts/udm/timeoff-requests.d.ts +3 -0
- package/dist/dts/udm/users.d.ts +3 -0
- package/dist/dts/usage/index.d.ts +1 -0
- package/dist/dts/usage/types.d.ts +33 -0
- package/dist/dts/users/accessors.d.ts +10 -0
- package/dist/dts/users/api.d.ts +23 -0
- package/dist/dts/users/index.d.ts +13 -0
- package/dist/dts/variables.d.ts +27 -0
- package/dist/dts/webhooks/index.d.ts +1 -0
- package/dist/dts/webhooks/types.d.ts +11 -0
- package/dist/dts/workspace-elements/index.d.ts +1 -0
- package/dist/dts/workspace-elements/types.d.ts +77 -0
- package/dist/dts/workspace-elements-catalog/index.d.ts +27 -0
- package/dist/dts/workspace-updates/index.d.ts +1 -0
- package/dist/dts/workspace-updates/types.d.ts +6 -0
- package/dist/dts/workspaces/api.d.ts +5 -0
- package/dist/dts/workspaces/constants.d.ts +4 -0
- package/dist/dts/workspaces/index.d.ts +3 -0
- package/dist/dts/workspaces/types.d.ts +175 -0
- package/dist/index.d.ts +5022 -0
- package/dist/index.js +11815 -0
- package/dist/index.js.map +1 -0
- package/dist/index.module.d.mts +5022 -0
- package/dist/index.module.mjs +11551 -0
- package/dist/index.module.mjs.map +1 -0
- package/package.json +96 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { ConnectorDataCollection } from '..';
|
|
2
|
+
import { DataSchema } from '../../../../data-schema';
|
|
3
|
+
import { ConnectorMethodImplementationType } from '../../../methods';
|
|
4
|
+
import { ConnectorDataCollectionEvent } from '.';
|
|
5
|
+
interface ConnectorDataCollectionEventMethodTypeArgs<ImplementationFields = unknown> {
|
|
6
|
+
event: ConnectorDataCollectionEvent<ImplementationFields>;
|
|
7
|
+
collection: ConnectorDataCollection;
|
|
8
|
+
}
|
|
9
|
+
export interface ConnectorDataCollectionEventMethodType<ImplementationFields = unknown> {
|
|
10
|
+
fileKey?: string;
|
|
11
|
+
getInputSchema?: (args: ConnectorDataCollectionEventMethodTypeArgs<ImplementationFields>) => DataSchema;
|
|
12
|
+
getOutputSchema?: (args: ConnectorDataCollectionEventMethodTypeArgs<ImplementationFields>) => DataSchema;
|
|
13
|
+
supportedImplementationTypes: ConnectorMethodImplementationType[];
|
|
14
|
+
}
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import { DataSchema } from '../../../data-schema';
|
|
2
|
+
import { ConnectorDataLocationBase } from '../base';
|
|
3
|
+
import { ConnectorDataLocationMethod } from '../methods';
|
|
4
|
+
import { ConnectorDataCollectionEvent } from './events';
|
|
5
|
+
import { ConnectorDataCollectionMethodType } from './methods/base';
|
|
6
|
+
import { DataCollectionCreateConfigType } from './methods/create';
|
|
7
|
+
import { DataCollectionListConfigType } from './methods/list';
|
|
8
|
+
import { DataCollectionMatchConfigType } from './methods/match';
|
|
9
|
+
import { DataCollectionUpdateConfigType } from './methods/update';
|
|
10
|
+
export * from './events';
|
|
11
|
+
export declare const DataLocationTypeCollection: {
|
|
12
|
+
spec: ConnectorDataCollectionMethodType<unknown>;
|
|
13
|
+
recordFromFields: ConnectorDataCollectionMethodType<unknown>;
|
|
14
|
+
customFieldsSchema: ConnectorDataCollectionMethodType<unknown>;
|
|
15
|
+
fieldsFromApi: ConnectorDataCollectionMethodType<unknown>;
|
|
16
|
+
fieldsToApi: ConnectorDataCollectionMethodType<unknown>;
|
|
17
|
+
methods: {
|
|
18
|
+
list: ConnectorDataCollectionMethodType<DataCollectionListConfigType>;
|
|
19
|
+
findById: ConnectorDataCollectionMethodType<unknown>;
|
|
20
|
+
match: ConnectorDataCollectionMethodType<DataCollectionMatchConfigType>;
|
|
21
|
+
search: ConnectorDataCollectionMethodType<unknown>;
|
|
22
|
+
create: ConnectorDataCollectionMethodType<DataCollectionCreateConfigType>;
|
|
23
|
+
update: ConnectorDataCollectionMethodType<DataCollectionUpdateConfigType>;
|
|
24
|
+
delete: ConnectorDataCollectionMethodType<unknown>;
|
|
25
|
+
find: ConnectorDataCollectionMethodType<{
|
|
26
|
+
queryFields: string[];
|
|
27
|
+
}>;
|
|
28
|
+
};
|
|
29
|
+
recordToApi: ConnectorDataCollectionMethodType<unknown>;
|
|
30
|
+
recordFromApi: ConnectorDataCollectionMethodType<unknown>;
|
|
31
|
+
recordFromApiMapping: ConnectorDataCollectionMethodType<unknown>;
|
|
32
|
+
recordFromApiCode: ConnectorDataCollectionMethodType<unknown>;
|
|
33
|
+
fieldsToApiMapping: ConnectorDataCollectionMethodType<unknown>;
|
|
34
|
+
fieldsToApiCode: ConnectorDataCollectionMethodType<unknown>;
|
|
35
|
+
};
|
|
36
|
+
export interface ConnectorDataCollection extends ConnectorDataLocationBase {
|
|
37
|
+
type: 'collection';
|
|
38
|
+
fieldsSchema?: DataSchema;
|
|
39
|
+
isHidden?: boolean;
|
|
40
|
+
customFields?: boolean;
|
|
41
|
+
customFieldsSchema?: ConnectorDataLocationMethod;
|
|
42
|
+
spec?: ConnectorDataLocationMethod;
|
|
43
|
+
recordFromFields?: ConnectorDataLocationMethod;
|
|
44
|
+
fieldsFromApi?: ConnectorDataLocationMethod;
|
|
45
|
+
recordFromApi?: ConnectorDataLocationMethod;
|
|
46
|
+
recordFromApiCode?: ConnectorDataLocationMethod;
|
|
47
|
+
recordFromApiMapping?: ConnectorDataLocationMethod;
|
|
48
|
+
recordToApi?: ConnectorDataLocationMethod;
|
|
49
|
+
fieldsToApi?: ConnectorDataLocationMethod;
|
|
50
|
+
fieldsToApiCode?: ConnectorDataLocationMethod;
|
|
51
|
+
fieldsToApiMapping?: ConnectorDataLocationMethod;
|
|
52
|
+
methods?: {
|
|
53
|
+
list?: ConnectorDataLocationMethod<DataCollectionListConfigType>;
|
|
54
|
+
findById?: ConnectorDataLocationMethod;
|
|
55
|
+
match?: ConnectorDataLocationMethod<DataCollectionMatchConfigType>;
|
|
56
|
+
search?: ConnectorDataLocationMethod;
|
|
57
|
+
create?: ConnectorDataLocationMethod<DataCollectionCreateConfigType>;
|
|
58
|
+
update?: ConnectorDataLocationMethod<DataCollectionUpdateConfigType>;
|
|
59
|
+
delete?: ConnectorDataLocationMethod;
|
|
60
|
+
find?: ConnectorDataLocationMethod<{
|
|
61
|
+
queryFields?: string[];
|
|
62
|
+
}>;
|
|
63
|
+
};
|
|
64
|
+
events?: Partial<Record<'created' | 'updated' | 'deleted', ConnectorDataCollectionEvent>>;
|
|
65
|
+
udm?: Partial<Record<string, {
|
|
66
|
+
extract?: ConnectorDataLocationMethod;
|
|
67
|
+
parse?: ConnectorDataLocationMethod;
|
|
68
|
+
}>>;
|
|
69
|
+
}
|
|
70
|
+
export declare const ConnectorDataCollectionMethodKeys: Array<keyof typeof DataLocationTypeCollection.methods>;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { ConnectorDataCollection } from '..';
|
|
2
|
+
import { DataSchema } from '../../../../data-schema';
|
|
3
|
+
import { ConnectorMethodImplementationType } from '../../../methods';
|
|
4
|
+
import { ConnectorSpec } from '../../../types';
|
|
5
|
+
import { ConnectorDataLocationMethod } from '../../methods';
|
|
6
|
+
import { DataCollectionSpec } from '../../types';
|
|
7
|
+
export interface ConnectorDataCollectionMethodType<ConfigFields = unknown> {
|
|
8
|
+
name?: string;
|
|
9
|
+
description?: string;
|
|
10
|
+
fileKey?: string;
|
|
11
|
+
getConfigSchema?: (args: ConnectorDataCollectionMethodTypeArgs<ConfigFields>) => DataSchema;
|
|
12
|
+
getInputSchema?: (args: ConnectorDataCollectionMethodTypeArgs<ConfigFields>) => DataSchema;
|
|
13
|
+
getOutputSchema?: (args: ConnectorDataCollectionMethodTypeArgs<ConfigFields>) => DataSchema;
|
|
14
|
+
supportedImplementationTypes: ConnectorMethodImplementationType[];
|
|
15
|
+
isDeprecated?: boolean;
|
|
16
|
+
}
|
|
17
|
+
interface ConnectorDataCollectionMethodTypeArgs<ConfigFields = unknown> {
|
|
18
|
+
method?: ConnectorDataLocationMethod<ConfigFields>;
|
|
19
|
+
collectionHandler?: ConnectorDataCollection;
|
|
20
|
+
collectionSpec?: DataCollectionSpec;
|
|
21
|
+
connectorSpec?: ConnectorSpec;
|
|
22
|
+
parameters?: any;
|
|
23
|
+
}
|
|
24
|
+
export {};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { ConnectorDataCollectionMethodType } from './base';
|
|
2
|
+
export interface DataCollectionCreateConfigType {
|
|
3
|
+
fields?: string[];
|
|
4
|
+
requiredFields?: string[];
|
|
5
|
+
excludedFields?: string[];
|
|
6
|
+
}
|
|
7
|
+
export declare const DataCollectionMethodCreate: ConnectorDataCollectionMethodType<DataCollectionCreateConfigType>;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { ConnectorDataCollectionMethodType } from './base';
|
|
2
|
+
export interface DataCollectionUpdateConfigType {
|
|
3
|
+
fields?: string[];
|
|
4
|
+
excludedFields?: string[];
|
|
5
|
+
}
|
|
6
|
+
export declare const DataCollectionMethodUpdate: ConnectorDataCollectionMethodType<DataCollectionUpdateConfigType>;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { ConnectorDataLocationBase } from '../base';
|
|
2
|
+
import { ConnectorDataLocationMethod } from '../methods';
|
|
3
|
+
import { ConnectorDataDirectoryMethodType } from './methods/base';
|
|
4
|
+
export declare const DataLocationTypeDirectory: {
|
|
5
|
+
spec: ConnectorDataDirectoryMethodType<unknown>;
|
|
6
|
+
methods: {
|
|
7
|
+
list: ConnectorDataDirectoryMethodType<unknown>;
|
|
8
|
+
};
|
|
9
|
+
};
|
|
10
|
+
export interface ConnectorDataDirectory extends ConnectorDataLocationBase {
|
|
11
|
+
type: 'directory';
|
|
12
|
+
spec?: ConnectorDataLocationMethod;
|
|
13
|
+
methods: {
|
|
14
|
+
list: ConnectorDataLocationMethod<any>;
|
|
15
|
+
};
|
|
16
|
+
}
|
|
17
|
+
export declare const ConnectorDataDirectoryMethodKeys: Array<keyof typeof DataLocationTypeDirectory.methods>;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { ConnectorDataDirectory } from '..';
|
|
2
|
+
import { DataSchema } from '../../../../data-schema';
|
|
3
|
+
import { ConnectorMethodImplementationType } from '../../../methods';
|
|
4
|
+
import { ConnectorDataLocationMethod } from '../../methods';
|
|
5
|
+
export interface ConnectorDataDirectoryMethodType<ConfigType = unknown> {
|
|
6
|
+
name?: string;
|
|
7
|
+
description?: string;
|
|
8
|
+
fileKey?: string;
|
|
9
|
+
getConfigSchema?: (args: ConnectorDataDirectoryMethodTypeArgs<ConfigType>) => DataSchema;
|
|
10
|
+
getInputSchema?: (args: ConnectorDataDirectoryMethodTypeArgs<ConfigType>) => DataSchema;
|
|
11
|
+
getOutputSchema?: (args: ConnectorDataDirectoryMethodTypeArgs<ConfigType>) => DataSchema;
|
|
12
|
+
supportedImplementationTypes: ConnectorMethodImplementationType[];
|
|
13
|
+
}
|
|
14
|
+
interface ConnectorDataDirectoryMethodTypeArgs<ConfigType = unknown> {
|
|
15
|
+
method: ConnectorDataLocationMethod<ConfigType>;
|
|
16
|
+
directory: ConnectorDataDirectory;
|
|
17
|
+
}
|
|
18
|
+
export {};
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { ConnectorMethodImplementation, ConnectorMethodImplementationBase, ConnectorMethodImplementationType } from '../methods';
|
|
2
|
+
import { ApiRequestSpec } from './types';
|
|
3
|
+
export type ConnectorDataLocationMethod<ConfigFields = unknown, ImplementationFields extends ConnectorMethodImplementation | ConnectorMethodImplementationBase = ConnectorMethodImplementationBase> = {
|
|
4
|
+
apiRequests?: ApiRequestSpec[];
|
|
5
|
+
} & ImplementationFields & ConfigFields;
|
|
6
|
+
export declare const DataLocationMethodImplementationTypes: ConnectorMethodImplementationType[];
|
|
@@ -0,0 +1,258 @@
|
|
|
1
|
+
import { ConnectorDataCollection } from './collections';
|
|
2
|
+
import { ConnectorDataDirectory } from './directories';
|
|
3
|
+
import { DataCollectionEvent, DataCollectionEventType, DataRecord } from '../../data-collections';
|
|
4
|
+
import { DataSchema } from '../../data-schema';
|
|
5
|
+
export type DataLocationSpec = DataCollectionSpec | DataDirectorySpec;
|
|
6
|
+
export declare enum DataLocationType {
|
|
7
|
+
directory = "directory",
|
|
8
|
+
collection = "collection"
|
|
9
|
+
}
|
|
10
|
+
export interface DataLocationListItem {
|
|
11
|
+
key: string;
|
|
12
|
+
name: string;
|
|
13
|
+
type: DataLocationType;
|
|
14
|
+
isHidden?: boolean;
|
|
15
|
+
}
|
|
16
|
+
export interface DataLocationPointer {
|
|
17
|
+
key: string;
|
|
18
|
+
parameters?: Record<string, any>;
|
|
19
|
+
type?: DataLocationType;
|
|
20
|
+
}
|
|
21
|
+
export interface DataLocation {
|
|
22
|
+
key?: string;
|
|
23
|
+
parameters?: any;
|
|
24
|
+
path?: string;
|
|
25
|
+
name?: string;
|
|
26
|
+
type?: DataLocationType;
|
|
27
|
+
isDefault?: boolean;
|
|
28
|
+
read?: boolean;
|
|
29
|
+
write?: boolean;
|
|
30
|
+
}
|
|
31
|
+
export interface DataLocationMixin {
|
|
32
|
+
key: string;
|
|
33
|
+
parameters?: any;
|
|
34
|
+
}
|
|
35
|
+
interface DataLocationSpecBase {
|
|
36
|
+
type: DataLocationType;
|
|
37
|
+
key?: string;
|
|
38
|
+
name: string;
|
|
39
|
+
parametersSchema?: DataSchema;
|
|
40
|
+
}
|
|
41
|
+
export interface DataCollectionSpec extends DataLocationSpecBase {
|
|
42
|
+
fieldsSchema?: DataSchema;
|
|
43
|
+
list?: DataCollectionListSpec;
|
|
44
|
+
search?: DataCollectionSearchSpec;
|
|
45
|
+
match?: DataCollectionMatchSpec;
|
|
46
|
+
findById?: DataCollectionFindByIdSpec;
|
|
47
|
+
create?: DataCollectionCreateSpec;
|
|
48
|
+
update?: DataCollectionUpdateSpec;
|
|
49
|
+
delete?: DataCollectionDeleteSpec;
|
|
50
|
+
events?: DataCollectionEventsSpec;
|
|
51
|
+
customFields?: boolean;
|
|
52
|
+
udm?: DataCollectionUdmsSpec;
|
|
53
|
+
find?: DataCollectionFindSpec;
|
|
54
|
+
}
|
|
55
|
+
export interface ApiRequestSpec {
|
|
56
|
+
path: any;
|
|
57
|
+
method: any;
|
|
58
|
+
}
|
|
59
|
+
export declare enum DataDirectoryOperation {
|
|
60
|
+
list = "list"
|
|
61
|
+
}
|
|
62
|
+
export interface DataDirectorySpec extends DataLocationSpecBase {
|
|
63
|
+
locations?: DataLocation[];
|
|
64
|
+
}
|
|
65
|
+
export interface DataCollectionMethodSpec {
|
|
66
|
+
apiRequests?: ApiRequestSpec[];
|
|
67
|
+
}
|
|
68
|
+
export interface DataCollectionFindSpec extends DataCollectionMethodSpec {
|
|
69
|
+
queryFields?: string[];
|
|
70
|
+
}
|
|
71
|
+
export interface DataCollectionMatchSpec extends DataCollectionMethodSpec {
|
|
72
|
+
fields?: string[];
|
|
73
|
+
}
|
|
74
|
+
export interface DataCollectionListSpec extends DataCollectionMethodSpec {
|
|
75
|
+
filterFields?: string[];
|
|
76
|
+
}
|
|
77
|
+
export interface DataCollectionSearchSpec extends DataCollectionMethodSpec {
|
|
78
|
+
}
|
|
79
|
+
export interface DataCollectionFindByIdSpec extends DataCollectionMethodSpec {
|
|
80
|
+
}
|
|
81
|
+
export interface DataCollectionCreateSpec extends DataCollectionMethodSpec {
|
|
82
|
+
fields?: string[];
|
|
83
|
+
requiredFields?: string[];
|
|
84
|
+
excludedFields?: string[];
|
|
85
|
+
}
|
|
86
|
+
export interface DataCollectionUpdateSpec extends DataCollectionMethodSpec {
|
|
87
|
+
fields?: string[];
|
|
88
|
+
excludedFields?: string[];
|
|
89
|
+
}
|
|
90
|
+
export interface DataCollectionDeleteSpec extends DataCollectionMethodSpec {
|
|
91
|
+
}
|
|
92
|
+
export type DataCollectionUdmSpec = {
|
|
93
|
+
fields?: string[];
|
|
94
|
+
extract?: Record<string, any>;
|
|
95
|
+
parse?: Record<string, any>;
|
|
96
|
+
};
|
|
97
|
+
export type DataCollectionUdmsSpec = Record<string, DataCollectionUdmSpec>;
|
|
98
|
+
export type DataCollectionEventTypeSpec = {
|
|
99
|
+
type: 'push' | 'pull';
|
|
100
|
+
isFullScan?: boolean;
|
|
101
|
+
isIdOnly?: boolean;
|
|
102
|
+
};
|
|
103
|
+
export type DataCollectionEventsSpec = {
|
|
104
|
+
[value in DataCollectionEventType]: DataCollectionEventTypeSpec;
|
|
105
|
+
} & {
|
|
106
|
+
all?: DataCollectionEventTypeSpec;
|
|
107
|
+
};
|
|
108
|
+
export interface DataCollectionMethodRequest {
|
|
109
|
+
parameters?: Record<string, any>;
|
|
110
|
+
}
|
|
111
|
+
export interface DataCollectionFindRequest {
|
|
112
|
+
query?: any;
|
|
113
|
+
cursor?: string;
|
|
114
|
+
}
|
|
115
|
+
export interface DataCollectionFindResponse {
|
|
116
|
+
records: DataRecord[];
|
|
117
|
+
cursor?: string;
|
|
118
|
+
}
|
|
119
|
+
export interface DataCollectionListRequest extends DataCollectionMethodRequest {
|
|
120
|
+
filter?: any;
|
|
121
|
+
unifiedFilter?: any;
|
|
122
|
+
cursor?: string;
|
|
123
|
+
}
|
|
124
|
+
export interface DataCollectionListResponseDrilldown {
|
|
125
|
+
parameters?: Record<string, any>;
|
|
126
|
+
filter?: Record<string, any>;
|
|
127
|
+
}
|
|
128
|
+
export interface DataCollectionListResponse {
|
|
129
|
+
records: DataRecord[];
|
|
130
|
+
drilldowns?: Array<DataCollectionListResponseDrilldown>;
|
|
131
|
+
cursor?: string;
|
|
132
|
+
}
|
|
133
|
+
export interface DataCollectionSearchRequest extends DataCollectionMethodRequest {
|
|
134
|
+
query: string;
|
|
135
|
+
cursor?: string;
|
|
136
|
+
}
|
|
137
|
+
export interface DataCollectionSearchResponse {
|
|
138
|
+
records: DataRecord[];
|
|
139
|
+
cursor?: string;
|
|
140
|
+
}
|
|
141
|
+
export interface DataCollectionFindByIdRequest extends DataCollectionMethodRequest {
|
|
142
|
+
id: string;
|
|
143
|
+
udm?: string;
|
|
144
|
+
}
|
|
145
|
+
export interface DataCollectionFindByIdResponse {
|
|
146
|
+
record: DataRecord;
|
|
147
|
+
}
|
|
148
|
+
export interface DataCollectionMatchRequest extends DataCollectionMethodRequest {
|
|
149
|
+
query: Record<string, any>;
|
|
150
|
+
}
|
|
151
|
+
export interface DataCollectionMatchResponse {
|
|
152
|
+
record?: DataRecord;
|
|
153
|
+
}
|
|
154
|
+
export interface DataCollectionCreateRequest extends DataCollectionMethodRequest {
|
|
155
|
+
fields: Record<string, any>;
|
|
156
|
+
}
|
|
157
|
+
export interface DataCollectionCreateResponse {
|
|
158
|
+
id: string;
|
|
159
|
+
}
|
|
160
|
+
export interface DataCollectionUpdateRequest extends DataCollectionMethodRequest {
|
|
161
|
+
id: string;
|
|
162
|
+
fields: Record<string, any>;
|
|
163
|
+
}
|
|
164
|
+
export interface DataCollectionUpdateResponse {
|
|
165
|
+
id: string;
|
|
166
|
+
}
|
|
167
|
+
export interface DataCollectionDeleteRequest extends DataCollectionMethodRequest {
|
|
168
|
+
id: string;
|
|
169
|
+
}
|
|
170
|
+
export interface DataCollectionDeleteResponse {
|
|
171
|
+
}
|
|
172
|
+
export interface DataCollectionSubscribeRequest extends DataCollectionMethodRequest {
|
|
173
|
+
events?: {
|
|
174
|
+
created?: boolean;
|
|
175
|
+
updated?: boolean;
|
|
176
|
+
deleted?: boolean;
|
|
177
|
+
};
|
|
178
|
+
udm?: string;
|
|
179
|
+
webhookUri: string;
|
|
180
|
+
}
|
|
181
|
+
export interface DataCollectionSubscribeResponse {
|
|
182
|
+
subscriptionId: string;
|
|
183
|
+
pullIntervalSeconds?: number;
|
|
184
|
+
cursor?: string;
|
|
185
|
+
}
|
|
186
|
+
export interface DataCollectionUpdateSubscriptionRequest extends DataCollectionSubscribeRequest {
|
|
187
|
+
subscriptionId: string;
|
|
188
|
+
cursor?: string;
|
|
189
|
+
}
|
|
190
|
+
export interface DataCollectionUpdateSubscriptionResponse extends Omit<DataCollectionSubscribeResponse, 'subscriptionId'> {
|
|
191
|
+
}
|
|
192
|
+
export interface DataCollectionUnsubscribeRequest {
|
|
193
|
+
subscriptionId: string;
|
|
194
|
+
}
|
|
195
|
+
export interface DataCollectionUnsubscribeResponse {
|
|
196
|
+
}
|
|
197
|
+
export interface DataCollectionEventsRequest extends DataCollectionMethodRequest {
|
|
198
|
+
subscriptionId: string;
|
|
199
|
+
cursor: string;
|
|
200
|
+
}
|
|
201
|
+
export interface DataCollectionEventsResponse {
|
|
202
|
+
events: DataCollectionEvent[];
|
|
203
|
+
cursor?: string;
|
|
204
|
+
state?: any;
|
|
205
|
+
}
|
|
206
|
+
export interface DataEventWebhookPayload {
|
|
207
|
+
subscriptionId: string;
|
|
208
|
+
events: DataCollectionEvent[];
|
|
209
|
+
}
|
|
210
|
+
export interface DataCollectionParseUnifiedFieldsRequest {
|
|
211
|
+
udm: string;
|
|
212
|
+
unifiedFields: Record<string, any>;
|
|
213
|
+
}
|
|
214
|
+
export interface DataCollectionParseUnifiedFieldsResponse {
|
|
215
|
+
fields: any;
|
|
216
|
+
}
|
|
217
|
+
export interface DataDirectoryListRequest {
|
|
218
|
+
cursor?: string;
|
|
219
|
+
}
|
|
220
|
+
export interface DataDirectoryListResponse {
|
|
221
|
+
locations: DataLocation[];
|
|
222
|
+
cursor?: string;
|
|
223
|
+
}
|
|
224
|
+
export declare const ConnectorDataLocationTypes: {
|
|
225
|
+
collection: {
|
|
226
|
+
spec: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
227
|
+
recordFromFields: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
228
|
+
customFieldsSchema: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
229
|
+
fieldsFromApi: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
230
|
+
fieldsToApi: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
231
|
+
methods: {
|
|
232
|
+
list: import("./collections/methods/base").ConnectorDataCollectionMethodType<import("./collections/methods/list").DataCollectionListConfigType>;
|
|
233
|
+
findById: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
234
|
+
match: import("./collections/methods/base").ConnectorDataCollectionMethodType<import("./collections/methods/match").DataCollectionMatchConfigType>;
|
|
235
|
+
search: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
236
|
+
create: import("./collections/methods/base").ConnectorDataCollectionMethodType<import("./collections/methods/create").DataCollectionCreateConfigType>;
|
|
237
|
+
update: import("./collections/methods/base").ConnectorDataCollectionMethodType<import("./collections/methods/update").DataCollectionUpdateConfigType>;
|
|
238
|
+
delete: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
239
|
+
find: import("./collections/methods/base").ConnectorDataCollectionMethodType<{
|
|
240
|
+
queryFields: string[];
|
|
241
|
+
}>;
|
|
242
|
+
};
|
|
243
|
+
recordToApi: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
244
|
+
recordFromApi: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
245
|
+
recordFromApiMapping: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
246
|
+
recordFromApiCode: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
247
|
+
fieldsToApiMapping: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
248
|
+
fieldsToApiCode: import("./collections/methods/base").ConnectorDataCollectionMethodType<unknown>;
|
|
249
|
+
};
|
|
250
|
+
directory: {
|
|
251
|
+
spec: import("./directories/methods/base").ConnectorDataDirectoryMethodType<unknown>;
|
|
252
|
+
methods: {
|
|
253
|
+
list: import("./directories/methods/base").ConnectorDataDirectoryMethodType<unknown>;
|
|
254
|
+
};
|
|
255
|
+
};
|
|
256
|
+
};
|
|
257
|
+
export type ConnectorDataLocation = ConnectorDataCollection | ConnectorDataDirectory;
|
|
258
|
+
export {};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { DataSchema } from '../../data-schema';
|
|
2
|
+
import { ConnectorDataLocation, DataCollectionSpec, DataLocationPointer } from '.';
|
|
3
|
+
export declare function getDataLocationMethodPath(locationKey: any, methodKey: any): string;
|
|
4
|
+
export declare function dataLocationParametersMatch({ locationParameters, targetParameters, }: {
|
|
5
|
+
locationParameters: Record<string, any>;
|
|
6
|
+
targetParameters: Record<string, any>;
|
|
7
|
+
}): boolean;
|
|
8
|
+
export declare function parseDataLocationPath(path: string): DataLocationPointer;
|
|
9
|
+
export declare function parseDataLocationPath(path: string | undefined): DataLocationPointer | undefined;
|
|
10
|
+
export declare function makeDataLocationPath(pointer: DataLocationPointer): string;
|
|
11
|
+
export declare function makeDataLocationPath(pointer: DataLocationPointer | undefined): string | undefined;
|
|
12
|
+
export declare function makeDataLocationOperationPath(collectionPath: string, operation: string): string;
|
|
13
|
+
export declare function isSameDataLocation(location1: DataLocationPointer, location2: DataLocationPointer): boolean;
|
|
14
|
+
export declare function isDataLocationMethodSupported(location: ConnectorDataLocation, methodKey: string): boolean;
|
|
15
|
+
export declare function getDataCollectionCreateFields(spec: DataCollectionSpec): DataSchema | undefined;
|
|
16
|
+
export declare function getDataCollectionUpdateFields(spec: DataCollectionSpec): DataSchema | undefined;
|
|
17
|
+
export declare function getWritableFieldsSchema(spec: DataCollectionSpec): DataSchema | undefined;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { DataSchema } from '../data-schema';
|
|
2
|
+
export declare const DATA_RECORD_SCHEMA: DataSchema;
|
|
3
|
+
export declare function makeDataRecordSchema({ fieldsSchema, udm, rawFieldsSchema, }: {
|
|
4
|
+
fieldsSchema?: DataSchema;
|
|
5
|
+
udm?: string;
|
|
6
|
+
rawFieldsSchema?: DataSchema;
|
|
7
|
+
}): DataSchema;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './types';
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { DataSchema } from '../../data-schema';
|
|
2
|
+
import { ConnectorMethodImplementation, ConnectorMethodImplementationType } from '../methods';
|
|
3
|
+
export declare enum ConnectorEventImplementationType {
|
|
4
|
+
GlobalWebhook = "global-webhook",
|
|
5
|
+
Webhook = "webhook"
|
|
6
|
+
}
|
|
7
|
+
interface ConnectorEventHandlerMethodSpec {
|
|
8
|
+
supportedImplementationTypes: ConnectorMethodImplementationType[];
|
|
9
|
+
isRequired: boolean;
|
|
10
|
+
}
|
|
11
|
+
export declare const ConnectorEventHandlerMethods: Record<ConnectorEventImplementationType, Record<string, ConnectorEventHandlerMethodSpec>>;
|
|
12
|
+
export interface ConnectorEventHandler {
|
|
13
|
+
key: string;
|
|
14
|
+
name: string;
|
|
15
|
+
description?: string;
|
|
16
|
+
parametersSchema?: DataSchema;
|
|
17
|
+
implementationType: ConnectorEventImplementationType;
|
|
18
|
+
schema?: DataSchema;
|
|
19
|
+
methods: Record<string, ConnectorMethodImplementation>;
|
|
20
|
+
}
|
|
21
|
+
export interface ConnectorEventSpec {
|
|
22
|
+
key: string;
|
|
23
|
+
name: string;
|
|
24
|
+
description?: string;
|
|
25
|
+
parametersSchema?: DataSchema;
|
|
26
|
+
schema?: DataSchema;
|
|
27
|
+
}
|
|
28
|
+
export interface ConnectorEventListItem {
|
|
29
|
+
key: string;
|
|
30
|
+
name: string;
|
|
31
|
+
}
|
|
32
|
+
export interface ConnectorEventGlobalWebhookGetEventSelectorResponse {
|
|
33
|
+
globalWebhookKey: string;
|
|
34
|
+
globalWebhookEventSelector: string;
|
|
35
|
+
}
|
|
36
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './types';
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { ConnectorMethodImplementation } from '../methods';
|
|
2
|
+
export interface ConnectorGlobalWebhookHandler {
|
|
3
|
+
key: string;
|
|
4
|
+
methods: {
|
|
5
|
+
handle: ConnectorMethodImplementation;
|
|
6
|
+
};
|
|
7
|
+
}
|
|
8
|
+
export interface ConnectorGlobalWebhookSpec {
|
|
9
|
+
key: string;
|
|
10
|
+
}
|
|
11
|
+
export interface ConnectorGlobalWebhookHandleRequest {
|
|
12
|
+
query: Record<string, string>;
|
|
13
|
+
data: any;
|
|
14
|
+
headers: Record<string, string>;
|
|
15
|
+
parameters: unknown;
|
|
16
|
+
}
|
|
17
|
+
export interface ConnectorGlobalWebhookHandleResponse {
|
|
18
|
+
events: Array<{
|
|
19
|
+
payload: any;
|
|
20
|
+
selector: string;
|
|
21
|
+
}>;
|
|
22
|
+
response?: {
|
|
23
|
+
headers?: Record<string, string>;
|
|
24
|
+
data?: any;
|
|
25
|
+
status?: number;
|
|
26
|
+
};
|
|
27
|
+
}
|
|
28
|
+
export interface ConnectorGlobalWebhookListItem {
|
|
29
|
+
key: string;
|
|
30
|
+
name: string;
|
|
31
|
+
description?: string;
|
|
32
|
+
uri?: string;
|
|
33
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { HttpRequestMethod } from '../http-requests';
|
|
2
|
+
export interface GraphqlApiClientInput {
|
|
3
|
+
path: string;
|
|
4
|
+
method: HttpRequestMethod;
|
|
5
|
+
query: string;
|
|
6
|
+
}
|
|
7
|
+
export interface GraphQLApiMapping {
|
|
8
|
+
path: string;
|
|
9
|
+
operationType: 'query' | 'mutation';
|
|
10
|
+
requestMapping: GraphQLFieldMapping[];
|
|
11
|
+
responseMapping?: any;
|
|
12
|
+
}
|
|
13
|
+
export interface GraphQLFieldMapping {
|
|
14
|
+
field: string;
|
|
15
|
+
args?: Record<string, any>;
|
|
16
|
+
subFields?: GraphQLFieldMapping[];
|
|
17
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export * from './auth';
|
|
2
|
+
export * from './constants';
|
|
3
|
+
export * from './data-locations';
|
|
4
|
+
export * from './data-records';
|
|
5
|
+
export * from './methods';
|
|
6
|
+
export * from './openapi';
|
|
7
|
+
export * from './operations';
|
|
8
|
+
export * from './rest-api';
|
|
9
|
+
export * from './types';
|
|
10
|
+
export * from './udm';
|
|
11
|
+
export * from './graphql-api';
|
|
12
|
+
export * from './global-webhooks';
|
|
13
|
+
export * from './events';
|