airbyte-faros-destination 0.14.13 → 0.15.0

package/lib/common/types.d.ts

@@ -0,0 +1,35 @@
+import { AirbyteConfig } from 'faros-airbyte-cdk';
+import { Dictionary } from 'ts-essentials';
+import { JSONataApplyMode } from '../converters/jsonata';
+export declare enum Edition {
+    COMMUNITY = "community",
+    CLOUD = "cloud"
+}
+export declare enum InvalidRecordStrategy {
+    FAIL = "FAIL",
+    SKIP = "SKIP"
+}
+export interface DestinationConfig extends AirbyteConfig {
+    readonly edition_configs: Dictionary<any>;
+    readonly dry_run?: boolean;
+    readonly invalid_record_strategy?: InvalidRecordStrategy;
+    readonly jsonata_destination_models?: ReadonlyArray<string>;
+    readonly jsonata_expression?: string;
+    readonly jsonata_mode?: JSONataApplyMode;
+    readonly origin?: string;
+    readonly accept_input_records_origin?: boolean;
+    readonly replace_origin_map?: string;
+    readonly exclude_fields_map?: string;
+    readonly redact_fields_map?: string;
+    readonly redact_custom_replace?: string;
+    readonly redact_custom_regex?: ReadonlyArray<string>;
+    readonly source_specific_configs?: Dictionary<any>;
+    readonly keep_alive?: boolean;
+    readonly skip_source_success_check?: boolean;
+    readonly faros_source_id?: string;
+    readonly fail_on_source_error?: boolean;
+}
+export declare const FLUSH: {
+    model: string;
+    record: {};
+};

package/lib/common/types.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FLUSH = exports.InvalidRecordStrategy = exports.Edition = void 0;
+const faros_js_client_1 = require("faros-js-client");
+var Edition;
+(function (Edition) {
+    Edition["COMMUNITY"] = "community";
+    Edition["CLOUD"] = "cloud";
+})(Edition || (exports.Edition = Edition = {}));
+var InvalidRecordStrategy;
+(function (InvalidRecordStrategy) {
+    InvalidRecordStrategy["FAIL"] = "FAIL";
+    InvalidRecordStrategy["SKIP"] = "SKIP";
+})(InvalidRecordStrategy || (exports.InvalidRecordStrategy = InvalidRecordStrategy = {}));
+exports.FLUSH = {
+    model: `__${faros_js_client_1.Operation.FLUSH}`,
+    record: {},
+};
+//# sourceMappingURL=types.js.map

package/lib/common/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":";;;AACA,qDAA0C;AAK1C,IAAY,OAGX;AAHD,WAAY,OAAO;IACjB,kCAAuB,CAAA;IACvB,0BAAe,CAAA;AACjB,CAAC,EAHW,OAAO,uBAAP,OAAO,QAGlB;AAED,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC/B,sCAAa,CAAA;IACb,sCAAa,CAAA;AACf,CAAC,EAHW,qBAAqB,qCAArB,qBAAqB,QAGhC;AAuBY,QAAA,KAAK,GAAG;IACnB,KAAK,EAAE,KAAK,2BAAS,CAAC,KAAK,EAAE;IAC7B,MAAM,EAAE,EAAE;CACX,CAAC"}

package/lib/community/hasura-backend.d.ts

@@ -0,0 +1,8 @@
+import { GraphQLBackend } from 'faros-js-client';
+import { HttpAgents } from '../destination';
+export declare class HasuraBackend implements GraphQLBackend {
+    private readonly api;
+    constructor(url: string, adminSecret?: string, httpAgents?: HttpAgents);
+    healthCheck(): Promise<void>;
+    postQuery(query: any, variables?: any): Promise<any>;
+}

package/lib/community/hasura-backend.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HasuraBackend = void 0;
+const axios_1 = __importDefault(require("axios"));
+class HasuraBackend {
+    constructor(url, adminSecret, httpAgents) {
+        this.api = axios_1.default.create({
+            ...httpAgents,
+            baseURL: url,
+            headers: {
+                'X-Hasura-Role': 'admin',
+                ...(adminSecret && { 'X-Hasura-Admin-Secret': adminSecret }),
+            },
+        });
+    }
+    async healthCheck() {
+        await this.api.get('/healthz');
+    }
+    async postQuery(query, variables) {
+        // extract and return the data field of axios response
+        const { data } = await this.api.post('/v1/graphql', {
+            query,
+            variables,
+        });
+        return data;
+    }
+}
+exports.HasuraBackend = HasuraBackend;
+//# sourceMappingURL=hasura-backend.js.map

package/lib/community/hasura-backend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasura-backend.js","sourceRoot":"","sources":["../../src/community/hasura-backend.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA2C;AAK3C,MAAa,aAAa;IAGxB,YAAY,GAAW,EAAE,WAAoB,EAAE,UAAuB;QACpE,IAAI,CAAC,GAAG,GAAG,eAAK,CAAC,MAAM,CAAC;YACtB,GAAG,UAAU;YACb,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE;gBACP,eAAe,EAAE,OAAO;gBACxB,GAAG,CAAC,WAAW,IAAI,EAAC,uBAAuB,EAAE,WAAW,EAAC,CAAC;aAC3D;SACF,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,WAAW;QACf,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAU,EAAE,SAAe;QACzC,sDAAsD;QACtD,MAAM,EAAC,IAAI,EAAC,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE;YAChD,KAAK;YACL,SAAS;SACV,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA1BD,sCA0BC"}

package/lib/converters/abstract-surveys/models.d.ts

@@ -0,0 +1,93 @@
+export type Survey = {
+    uid: string;
+    name: string;
+    description: string;
+    type: SurveyType;
+    status: SurveyStatus;
+    startedAt: Date;
+    endedAt: Date;
+    creator?: SurveyUser;
+    stats?: SurveyStats;
+    source: string;
+};
+export type SurveyQuestion = {
+    uid: string;
+    question?: string;
+    description?: string;
+    questionCategory: SurveyQuestionCategoryType;
+    responseType: SurveyResponseType;
+    source: string;
+};
+export type SurveyQuestionAssociation = {
+    survey: Survey;
+    question: SurveyQuestion;
+    order: number;
+};
+export type SurveyStats = {
+    questionCount: number;
+    invitationCount: number;
+    responseCount: number;
+};
+export type SurveyUser = {
+    uid: string;
+    email: string;
+    name: string;
+    source: string;
+};
+export type SurveyTeam = {
+    uid: string;
+    name: string;
+    description?: string;
+    source: string;
+};
+export type SurveyType = {
+    category: SurveyCategory;
+    detail: string;
+};
+export declare enum SurveyCategory {
+    ENPS = "ENPS",
+    NPS = "NPS",
+    Satisfaction = "Satisfaction",
+    Custom = "Custom"
+}
+export type SurveyStatus = {
+    category: SurveyStatusCategory;
+    detail: string;
+};
+export declare enum SurveyStatusCategory {
+    Completed = "Completed",
+    Canceled = "Canceled",
+    Planned = "Planned",
+    InProgress = "InProgress",
+    Custom = "Custom"
+}
+export type SurveyQuestionCategoryType = {
+    category: SurveyQuestionCategory;
+    detail: string;
+};
+export declare enum SurveyQuestionCategory {
+    AlignmentAndGoals = "AlignmentAndGoals",
+    DeveloperProductivity = "DeveloperProductivity",
+    ENPS = "ENPS",
+    NPS = "NPS",
+    Quality = "Quality",
+    Satisfaction = "Satisfaction",
+    SpeedAndAgility = "SpeedAndAgility",
+    CodingAssistants = "CodingAssistants",
+    Custom = "Custom"
+}
+export type SurveyResponseType = {
+    category: SurveyResponseCategory;
+    detail: string;
+};
+export declare enum SurveyResponseCategory {
+    Binary = "Binary",
+    LikertScale = "LikertScale",
+    MultipleChoice = "MultipleChoice",
+    NumericEntry = "NumericEntry",
+    OpenEnded = "OpenEnded",
+    RankOrder = "RankOrder",
+    Rating = "Rating",
+    Custom = "Custom"
+}
+export type QuestionCategoryMapping = Record<string, string>;

package/lib/converters/abstract-surveys/models.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SurveyResponseCategory = exports.SurveyQuestionCategory = exports.SurveyStatusCategory = exports.SurveyCategory = void 0;
+var SurveyCategory;
+(function (SurveyCategory) {
+    SurveyCategory["ENPS"] = "ENPS";
+    SurveyCategory["NPS"] = "NPS";
+    SurveyCategory["Satisfaction"] = "Satisfaction";
+    SurveyCategory["Custom"] = "Custom";
+})(SurveyCategory || (exports.SurveyCategory = SurveyCategory = {}));
+var SurveyStatusCategory;
+(function (SurveyStatusCategory) {
+    SurveyStatusCategory["Completed"] = "Completed";
+    SurveyStatusCategory["Canceled"] = "Canceled";
+    SurveyStatusCategory["Planned"] = "Planned";
+    SurveyStatusCategory["InProgress"] = "InProgress";
+    SurveyStatusCategory["Custom"] = "Custom";
+})(SurveyStatusCategory || (exports.SurveyStatusCategory = SurveyStatusCategory = {}));
+var SurveyQuestionCategory;
+(function (SurveyQuestionCategory) {
+    SurveyQuestionCategory["AlignmentAndGoals"] = "AlignmentAndGoals";
+    SurveyQuestionCategory["DeveloperProductivity"] = "DeveloperProductivity";
+    SurveyQuestionCategory["ENPS"] = "ENPS";
+    SurveyQuestionCategory["NPS"] = "NPS";
+    SurveyQuestionCategory["Quality"] = "Quality";
+    SurveyQuestionCategory["Satisfaction"] = "Satisfaction";
+    SurveyQuestionCategory["SpeedAndAgility"] = "SpeedAndAgility";
+    SurveyQuestionCategory["CodingAssistants"] = "CodingAssistants";
+    SurveyQuestionCategory["Custom"] = "Custom";
+})(SurveyQuestionCategory || (exports.SurveyQuestionCategory = SurveyQuestionCategory = {}));
+var SurveyResponseCategory;
+(function (SurveyResponseCategory) {
+    SurveyResponseCategory["Binary"] = "Binary";
+    SurveyResponseCategory["LikertScale"] = "LikertScale";
+    SurveyResponseCategory["MultipleChoice"] = "MultipleChoice";
+    SurveyResponseCategory["NumericEntry"] = "NumericEntry";
+    SurveyResponseCategory["OpenEnded"] = "OpenEnded";
+    SurveyResponseCategory["RankOrder"] = "RankOrder";
+    SurveyResponseCategory["Rating"] = "Rating";
+    SurveyResponseCategory["Custom"] = "Custom";
+})(SurveyResponseCategory || (exports.SurveyResponseCategory = SurveyResponseCategory = {}));
+//# sourceMappingURL=models.js.map

package/lib/converters/abstract-surveys/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../src/converters/abstract-surveys/models.ts"],"names":[],"mappings":";;;AAqDA,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,6BAAW,CAAA;IACX,+CAA6B,CAAA;IAC7B,mCAAiB,CAAA;AACnB,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAOD,IAAY,oBAMX;AAND,WAAY,oBAAoB;IAC9B,+CAAuB,CAAA;IACvB,6CAAqB,CAAA;IACrB,2CAAmB,CAAA;IACnB,iDAAyB,CAAA;IACzB,yCAAiB,CAAA;AACnB,CAAC,EANW,oBAAoB,oCAApB,oBAAoB,QAM/B;AAOD,IAAY,sBAUX;AAVD,WAAY,sBAAsB;IAChC,iEAAuC,CAAA;IACvC,yEAA+C,CAAA;IAC/C,uCAAa,CAAA;IACb,qCAAW,CAAA;IACX,6CAAmB,CAAA;IACnB,uDAA6B,CAAA;IAC7B,6DAAmC,CAAA;IACnC,+DAAqC,CAAA;IACrC,2CAAiB,CAAA;AACnB,CAAC,EAVW,sBAAsB,sCAAtB,sBAAsB,QAUjC;AAOD,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,2CAAiB,CAAA;IACjB,qDAA2B,CAAA;IAC3B,2DAAiC,CAAA;IACjC,uDAA6B,CAAA;IAC7B,iDAAuB,CAAA;IACvB,iDAAuB,CAAA;IACvB,2CAAiB,CAAA;IACjB,2CAAiB,CAAA;AACnB,CAAC,EATW,sBAAsB,sCAAtB,sBAAsB,QASjC"}

package/lib/converters/abstract-surveys/surveys.d.ts

@@ -0,0 +1,64 @@
+import { AirbyteRecord } from 'faros-airbyte-cdk';
+import { Converter, DestinationModel, DestinationRecord, StreamContext } from '../converter';
+import { QuestionCategoryMapping } from './models';
+type ColumnNameMapping = {
+    survey_name_column_name?: string;
+    survey_type_column_name?: string;
+    survey_description_column_name?: string;
+    survey_started_at_column_name?: string;
+    survey_ended_at_column_name?: string;
+    survey_status_column_name?: string;
+    respondent_name_column_name?: string;
+    respondent_email_column_name?: string;
+    respondent_team_name_column_name?: string;
+    respondent_team_id_column_name?: string;
+    question_category_column_name?: string;
+    response_type_column_name?: string;
+    question_column_name?: string;
+    response_submitted_at_column_name?: string;
+};
+export interface SurveysConfig {
+    survey_responses_table_name?: string;
+    survey_metadata_table_name?: string;
+    question_metadata_table_name?: string;
+    question_category_mapping?: QuestionCategoryMapping;
+    column_names_mapping?: ColumnNameMapping;
+    exclude_columns?: ReadonlyArray<string>;
+}
+export declare abstract class AbstractSurveys extends Converter {
+    abstract getSurveyId(record: AirbyteRecord): string | undefined;
+    abstract getTableName(record: AirbyteRecord): string | undefined;
+    getSubmittedAt(record: AirbyteRecord): string | undefined;
+    readonly destinationModels: ReadonlyArray<DestinationModel>;
+    private questionMetadata;
+    private surveyMetadata;
+    private surveyStats;
+    private usersSeen;
+    private teamsSeen;
+    private surveysSeen;
+    private questionsSeen;
+    private _config;
+    private _questionCategoryMapping;
+    private initialize;
+    protected get config(): SurveysConfig;
+    private get questionCategoryMapping();
+    convert(record: AirbyteRecord, ctx: StreamContext): Promise<ReadonlyArray<DestinationRecord>>;
+    private processQuestionMetadata;
+    private processSurveyMetadata;
+    private processResponse;
+    /** Upsert surveys to add stats and survey questions records to include metadata (question category and response type) **/
+    onProcessingComplete(ctx: StreamContext): Promise<ReadonlyArray<DestinationRecord>>;
+    private getQuestionWithMetadata;
+    private getResponseRecords;
+    private getSurveyRecord;
+    private updateSurveyStats;
+    private getFilteredQuestions;
+    private getSurveyData;
+    private getSurveyUser;
+    private getSurveyTeam;
+    static createQuestionUid(surveyId: string, question: string): string;
+    static getTeamUid(teamName: string): string | undefined;
+    static digest(input: string): string;
+    static getColumnValue(row: any, columnName: string): string | null;
+}
+export {};