@epilot/entity-mapping-client
Advanced tools
Comparing version 0.8.5 to 0.8.6
@@ -147,2 +147,6 @@ /* eslint-disable */ | ||
} | ||
/** | ||
* This string value will be replaced with the value of the loop index, when mapping in loop mode | ||
*/ | ||
export type LoopIndexString = "##LOOP_INDEX##"; | ||
export interface MapCondition { | ||
@@ -270,2 +274,56 @@ _exists?: ConditionNode; | ||
} | ||
export interface MappingSource { | ||
/** | ||
* Key aiming to identify source | ||
*/ | ||
key: string; | ||
/** | ||
* Each item describes a property under the main source and a possibly, a default value for its target attribute | ||
*/ | ||
sub_properties?: MappingSourceProperty[]; | ||
/** | ||
* Data Structure type of source | ||
*/ | ||
source_type: string; | ||
/** | ||
* Data Structure Type of the underlaying output value | ||
*/ | ||
possible_target_types?: MappingSourceTargetType[]; | ||
/** | ||
* Initial value of a relation to be added | ||
*/ | ||
initial_relation?: RelationAttribute; | ||
/** | ||
* Human readable name of the Source | ||
*/ | ||
title: string; | ||
/** | ||
* Human readable type of the source | ||
*/ | ||
sub_title?: string; | ||
target_settings?: { | ||
/** | ||
* Describes which actions the user can perform on each target, if specified. If not specified, all actions are allowed | ||
*/ | ||
allowed_ui_actions?: ("schema-select" | "attribute-select" | "target-delete" | "target-add" | "target")[]; | ||
/** | ||
* Whether its a read-only ui or not. Can be each target, or only the first. Overwrites uiActions | ||
*/ | ||
locked?: "each" | "first" | "system_recommendation"; | ||
/** | ||
* Whether all source mappings flow into a single attribute (e.g. address) | ||
*/ | ||
isSingleTarget?: boolean; | ||
/** | ||
* Determines whether a mapping target should be shown or not. Use if there are targets which cannot be manipulated by the UI. E.g journey_data | ||
*/ | ||
visibility?: { | ||
mode: "hide" | "show" | "message"; | ||
if: { | ||
[name: string]: string; | ||
}; | ||
message?: string; | ||
}; | ||
}; | ||
} | ||
export interface MappingSourceProperty { | ||
@@ -272,0 +330,0 @@ value: string; |
@@ -930,2 +930,9 @@ { | ||
}, | ||
"Loop_Index_String": { | ||
"type": "string", | ||
"description": "This string value will be replaced with the value of the loop index, when mapping in loop mode", | ||
"enum": [ | ||
"##LOOP_INDEX##" | ||
] | ||
}, | ||
"TargetConfig": { | ||
@@ -1449,2 +1456,105 @@ "type": "object", | ||
}, | ||
"MappingSource": { | ||
"type": "object", | ||
"properties": { | ||
"key": { | ||
"type": "string", | ||
"description": "Key aiming to identify source" | ||
}, | ||
"sub_properties": { | ||
"description": "Each item describes a property under the main source and a possibly, a default value for its target attribute", | ||
"type": "array", | ||
"items": { | ||
"$ref": "#/components/schemas/MappingSourceProperty" | ||
} | ||
}, | ||
"source_type": { | ||
"type": "string", | ||
"description": "Data Structure type of source" | ||
}, | ||
"possible_target_types": { | ||
"type": "array", | ||
"items": { | ||
"$ref": "#/components/schemas/MappingSourceTargetType" | ||
}, | ||
"description": "Data Structure Type of the underlaying output value" | ||
}, | ||
"initial_relation": { | ||
"description": "Initial value of a relation to be added", | ||
"$ref": "#/components/schemas/RelationAttribute" | ||
}, | ||
"title": { | ||
"type": "string", | ||
"description": "Human readable name of the Source" | ||
}, | ||
"sub_title": { | ||
"type": "string", | ||
"description": "Human readable type of the source" | ||
}, | ||
"target_settings": { | ||
"type": "object", | ||
"properties": { | ||
"allowed_ui_actions": { | ||
"type": "array", | ||
"items": { | ||
"type": "string", | ||
"enum": [ | ||
"schema-select", | ||
"attribute-select", | ||
"target-delete", | ||
"target-add", | ||
"target" | ||
] | ||
}, | ||
"description": "Describes which actions the user can perform on each target, if specified. If not specified, all actions are allowed" | ||
}, | ||
"locked": { | ||
"type": "string", | ||
"enum": [ | ||
"each", | ||
"first", | ||
"system_recommendation" | ||
], | ||
"description": "Whether its a read-only ui or not. Can be each target, or only the first. Overwrites uiActions" | ||
}, | ||
"isSingleTarget": { | ||
"type": "boolean", | ||
"description": "Whether all source mappings flow into a single attribute (e.g. address)" | ||
}, | ||
"visibility": { | ||
"description": "Determines whether a mapping target should be shown or not. Use if there are targets which cannot be manipulated by the UI. E.g journey_data", | ||
"type": "object", | ||
"properties": { | ||
"mode": { | ||
"type": "string", | ||
"enum": [ | ||
"hide", | ||
"show", | ||
"message" | ||
] | ||
}, | ||
"if": { | ||
"type": "object", | ||
"additionalProperties": { | ||
"type": "string" | ||
} | ||
}, | ||
"message": { | ||
"type": "string" | ||
} | ||
}, | ||
"required": [ | ||
"mode", | ||
"if" | ||
] | ||
} | ||
} | ||
} | ||
}, | ||
"required": [ | ||
"key", | ||
"title", | ||
"source_type" | ||
] | ||
}, | ||
"MappingSourceProperty": { | ||
@@ -1451,0 +1561,0 @@ "type": "object", |
{ | ||
"name": "@epilot/entity-mapping-client", | ||
"version": "0.8.5", | ||
"version": "0.8.6", | ||
"description": "JavaScript client library for the ePilot Entity Mapping API", | ||
@@ -28,3 +28,3 @@ "main": "dist/index.js", | ||
"bundle-definition": "webpack", | ||
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/entity-mapping-api.yaml", | ||
"openapi": "node ../../scripts/update-openapi.js /Users/mohannad/epilot/entity-mapping-api/openapi.yml", | ||
"typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts", | ||
@@ -31,0 +31,0 @@ "build": "tsc && npm run bundle-definition", |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
91597
2901
0