@devrev/airsync-sdk 2.0.0-beta.0 → 2.0.0-beta.10

package/dist/types/external-domain-metadata.d.ts

@@ -0,0 +1,197 @@
+export type SchemaVersion = 'v0.2.0';
+export type RecordTypeKey = string;
+export type FieldKey = string;
+export type EnumValueKey = string;
+export type StructTypeKey = string;
+export type RecordTypeCategoryKey = string;
+export type StateKey = string;
+export type StageKey = string;
+export type FieldType = 'bool' | 'int' | 'float' | 'text' | 'rich_text' | 'reference' | 'typed_reference' | 'enum' | 'date' | 'timestamp' | 'struct' | 'permission' | 'record_type_privilege' | 'field_privilege' | 'conditional_privilege' | 'participation';
+export type ReferenceType = 'child' | 'parent';
+export type FieldConditionComparator = 'eq' | 'ne';
+export type FieldConditionEffect = 'require' | 'show';
+export type RecordTypeScope = 'metadata_is_system_scoped' | 'data_is_system_scoped';
+export interface CollectionData {
+    min_length?: number;
+    max_length?: number;
+}
+export interface IntData {
+    min?: number;
+    max?: number;
+}
+export interface FloatData {
+    min?: number;
+    max?: number;
+}
+export interface TextData {
+    min_length?: number;
+    max_length?: number;
+}
+export interface EnumValue {
+    /** The enum value as it actually occurs in the json data. */
+    key: EnumValueKey;
+    name?: string;
+    description?: string;
+    /** Deprecated values may still occur in the data, but should not be used in new data. */
+    is_deprecated?: boolean;
+}
+export interface EnumData {
+    values: EnumValue[];
+}
+export interface ReferenceDetail {
+    /** The field in the target record type by which it is referenced. Assumed to be the primary key if not set. */
+    by_field?: FieldKey;
+}
+export interface ReferenceData {
+    refers_to: Record<RecordTypeKey, ReferenceDetail>;
+    /** A 'parent' reference refers to a record that has special ownership over the child. */
+    reference_type?: ReferenceType;
+}
+export interface TypedReferenceData {
+    refers_to: Record<RecordTypeKey, ReferenceDetail>;
+    /** A 'parent' reference refers to a record that has special ownership over the child. */
+    reference_type?: ReferenceType;
+}
+export interface StructData {
+    key?: StructTypeKey;
+}
+export interface ParticipationData {
+    refers_to: Record<RecordTypeKey, ReferenceDetail>;
+}
+export interface PermissionData {
+    member_id?: ReferenceData;
+    role?: EnumData;
+}
+export interface ConditionalPrivilegeData {
+    /** Record types or record type categories that can be targeted. */
+    type_keys: RecordTypeKey[];
+}
+export interface FieldPrivilegeData {
+    /** Record types or record type categories that can be targeted. */
+    type_keys: RecordTypeKey[];
+}
+export interface RecordTypePrivilegeData {
+    /** Record types or record type categories that can be targeted. */
+    type_keys: RecordTypeKey[];
+}
+export interface TargetTypeKeyData {
+    /** Record types or record type categories that can be targeted. */
+    type_keys: RecordTypeKey[];
+}
+/** Currently empty, reserved for future use. */
+export interface FieldReferenceData {
+    [key: string]: never;
+}
+/** Field definition; `type` selects which type-specific data property applies. */
+export interface Field {
+    type: FieldType;
+    name?: string;
+    description?: string;
+    /** Required in the domain model of the external system. */
+    is_required?: boolean;
+    /** Can't be set on create/update; filled in by some process in the system. */
+    is_read_only?: boolean | null;
+    is_write_only?: boolean | null;
+    /** Can be used for searching, sorting or filtering. */
+    is_indexed?: boolean | null;
+    /** Can be used to uniquely look up a record. */
+    is_identifier?: boolean | null;
+    default_value?: boolean | number | string;
+    /** If set, the field is a collection of the given type. */
+    collection?: CollectionData;
+    int?: IntData;
+    float?: FloatData;
+    text?: TextData;
+    enum?: EnumData | null;
+    reference?: ReferenceData;
+    typed_reference?: TypedReferenceData;
+    struct?: StructData;
+    permission?: PermissionData;
+    type_key?: TargetTypeKeyData;
+    field_reference?: FieldReferenceData;
+    record_type_privilege?: RecordTypePrivilegeData;
+    field_privilege?: FieldPrivilegeData;
+    conditional_privilege?: ConditionalPrivilegeData;
+    participation?: ParticipationData;
+}
+/** When the controlling field's value matches `value` (per `comparator`), `effect` is applied to `affected_fields`. */
+export interface FieldCondition {
+    value: unknown;
+    comparator: FieldConditionComparator;
+    affected_fields: FieldKey[];
+    effect: FieldConditionEffect;
+}
+export type FieldConditions = FieldCondition[];
+export interface CustomLinkNames {
+    forward_name: string;
+    backward_name: string;
+}
+export interface CustomLinkData {
+    /** The field that defines the link types in the system. */
+    link_type_field: FieldKey;
+    link_direction_names: Record<string, CustomLinkNames> | null;
+}
+export interface CustomStage {
+    /** Must match a key in the diagram's 'states' map or be a default: 'open', 'in_progress', 'closed'. */
+    state?: StateKey;
+    /** Stage names this stage can transition to. */
+    transitions_to?: StageKey[];
+}
+export interface CustomState {
+    name: string;
+    is_end_state?: boolean;
+    /** Sort order. */
+    ordinal?: number;
+}
+export interface StageDiagram {
+    /** The field that represents the stage in the external system. */
+    controlling_field: FieldKey;
+    /** Stage keys must match the enum values in the controlling field. */
+    stages: Record<StageKey, CustomStage>;
+    /** The stage the parent record type starts in when created. */
+    starting_stage?: StageKey;
+    states?: Record<StateKey, CustomState>;
+    /** No explicit transitions; create as an 'all-to-all' diagram. */
+    all_transitions_allowed?: boolean;
+}
+export interface RecordTypeCategory {
+    name?: string;
+    /** Whether a record can move between record types of this category while preserving its identity. */
+    are_record_type_conversions_possible?: boolean;
+}
+export interface Attachments {
+    is_extractable?: boolean;
+    /** Whether the connector supports creating attachments in the external system. */
+    is_loadable?: boolean;
+}
+export interface RecordType {
+    fields: Record<FieldKey, Field>;
+    name?: string;
+    description?: string;
+    category?: RecordTypeCategoryKey;
+    /** Whether the connector supports creating this record type in the external system. */
+    is_loadable?: boolean;
+    /** Whether the record type sends the complete system state in every sync. */
+    is_snapshot?: boolean;
+    /** No ID field; primarily used for authorization policies. */
+    no_identifier?: boolean;
+    scope?: RecordTypeScope;
+    conditions?: Record<FieldKey, FieldConditions>;
+    stage_diagram?: StageDiagram;
+    link_naming_data?: CustomLinkData;
+    attachments?: Attachments;
+}
+/** Reusable field structure. */
+export interface StructType {
+    fields: Record<FieldKey, Field>;
+    name?: string;
+}
+/** Describes the logical structure of an external system. */
+export interface ExternalDomainMetadata {
+    record_types: Record<RecordTypeKey, RecordType>;
+    record_type_categories?: Record<RecordTypeCategoryKey, RecordTypeCategory>;
+    struct_types?: Record<StructTypeKey, StructType>;
+    /** Version of the metadata format itself. */
+    schema_version?: SchemaVersion;
+}
+//# sourceMappingURL=external-domain-metadata.d.ts.map

package/dist/types/external-domain-metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"external-domain-metadata.d.ts","sourceRoot":"","sources":["../../src/types/external-domain-metadata.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC;AAErC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAE3C,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,KAAK,GACL,OAAO,GACP,MAAM,GACN,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,MAAM,GACN,MAAM,GACN,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,uBAAuB,GACvB,iBAAiB,GACjB,uBAAuB,GACvB,eAAe,CAAC;AAEpB,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE/C,MAAM,MAAM,wBAAwB,GAAG,IAAI,GAAG,IAAI,CAAC;AAEnD,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,MAAM,CAAC;AAEtD,MAAM,MAAM,eAAe,GACvB,2BAA2B,GAC3B,uBAAuB,CAAC;AAE5B,MAAM,WAAW,cAAc;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,OAAO;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,QAAQ;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,SAAS;IACxB,6DAA6D;IAC7D,GAAG,EAAE,YAAY,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yFAAyF;IACzF,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,SAAS,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,+GAA+G;IAC/G,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;IAClD,yFAAyF;IACzF,cAAc,CAAC,EAAE,aAAa,CAAC;CAChC;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;IAClD,yFAAyF;IACzF,cAAc,CAAC,EAAE,aAAa,CAAC;CAChC;AAED,MAAM,WAAW,UAAU;IACzB,GAAG,CAAC,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;CACnD;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC,mEAAmE;IACnE,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC,mEAAmE;IACnE,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC,mEAAmE;IACnE,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC,mEAAmE;IACnE,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,gDAAgD;AAChD,MAAM,WAAW,kBAAkB;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC;CACtB;AAED,kFAAkF;AAClF,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,uDAAuD;IACvD,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,gDAAgD;IAChD,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,aAAa,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;IAC1C,2DAA2D;IAC3D,UAAU,CAAC,EAAE,cAAc,CAAC;IAG5B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,IAAI,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IACvB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,qBAAqB,CAAC,EAAE,uBAAuB,CAAC;IAChD,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,qBAAqB,CAAC,EAAE,wBAAwB,CAAC;IACjD,aAAa,CAAC,EAAE,iBAAiB,CAAC;CACnC;AAED,uHAAuH;AACvH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,wBAAwB,CAAC;IACrC,eAAe,EAAE,QAAQ,EAAE,CAAC;IAC5B,MAAM,EAAE,oBAAoB,CAAC;CAC9B;AAED,MAAM,MAAM,eAAe,GAAG,cAAc,EAAE,CAAC;AAE/C,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,2DAA2D;IAC3D,eAAe,EAAE,QAAQ,CAAC;IAC1B,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED,MAAM,WAAW,WAAW;IAC1B,uGAAuG;IACvG,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,gDAAgD;IAChD,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kBAAkB;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,kEAAkE;IAClE,iBAAiB,EAAE,QAAQ,CAAC;IAC5B,sEAAsE;IACtE,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACtC,+DAA+D;IAC/D,cAAc,CAAC,EAAE,QAAQ,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACvC,kEAAkE;IAClE,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qGAAqG;IACrG,oCAAoC,CAAC,EAAE,OAAO,CAAC;CAChD;AAED,MAAM,WAAW,WAAW;IAC1B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,kFAAkF;IAClF,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IACjC,uFAAuF;IACvF,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,6EAA6E;IAC7E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,8DAA8D;IAC9D,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IAC/C,aAAa,CAAC,EAAE,YAAY,CAAC;IAC7B,gBAAgB,CAAC,EAAE,cAAc,CAAC;IAClC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,gCAAgC;AAChC,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,6DAA6D;AAC7D,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,MAAM,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IAChD,sBAAsB,CAAC,EAAE,MAAM,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAAC;IAC3E,YAAY,CAAC,EAAE,MAAM,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IACjD,6CAA6C;IAC7C,cAAc,CAAC,EAAE,aAAa,CAAC;CAChC"}