@ductape/sdk 0.1.8 → 0.1.9

package/dist/types/appBuilder.types.d.ts

@@ -0,0 +1,316 @@
+import { AuthTypes, Categories, DataFormats, DataTypes, HttpMethods, InputsTypes, PublicStates, StatusCodes, SuccessMarkerType, TokenPeriods } from './enums';
+import { IParsedInput, IParsedSample } from './inputs.types';
+import { IActionRequest } from './productsBuilder.types';
+import { IRequestExtension } from './requests.types';
+export interface ICreateAppBuilder {
+    app_name: string;
+    description: string;
+    unique?: boolean;
+    returned?: string;
+}
+export interface ICreateApp extends ICreateAppBuilder {
+    tag: string;
+}
+export interface IAppWebhook {
+    _id?: string;
+    name: string;
+    tag: string;
+    description: string;
+    envs: IAppWebhookEnv[];
+    events: IAppWebhookEvent[];
+}
+export interface IAppWebhookEnv {
+    _id?: string;
+    slug: string;
+    registration_url?: string;
+    method?: HttpMethods;
+    sample?: IActionRequest;
+    sample_data?: IParsedSample[];
+    __v?: number;
+}
+export interface IAppWebhookEvent {
+    _id?: string;
+    tag: string;
+    name: string;
+    selector: string;
+    selectorValue?: string;
+    description: string;
+    sample: Record<string, unknown>;
+    sample_data?: IParsedSample[];
+}
+export interface IAppAccess {
+    access_tag: string;
+    access: boolean;
+}
+export interface IAppAuth {
+    _id: string;
+    user_id: string;
+    app_id: string;
+    name: string;
+    tag: string;
+    setup_type: AuthTypes;
+    expiry: number;
+    period: TokenPeriods;
+    action_tag?: string;
+    tokens?: Omit<IActionRequest, 'input'>;
+    description: string;
+    __v: number;
+}
+export interface IAppAuthEnv {
+    _id?: string;
+    setup_id?: string;
+    env_id: string;
+    __v?: number;
+    base_url?: string;
+}
+/** Variable extracted from base_url (e.g. {{prefix}} in https://{{prefix}}-checkout.example.com). */
+export interface IBaseUrlVariable {
+    key: string;
+}
+export interface IAppEnv {
+    _id?: string;
+    env_name: string;
+    slug: string;
+    description?: string;
+    whitelist?: boolean;
+    active?: boolean;
+    __v?: number;
+    base_url?: string;
+    /** Keys extracted from base_url placeholders ({{key}} or :key). Filled during integration. */
+    base_url_variables?: IBaseUrlVariable[];
+    request_type?: DataFormats;
+}
+export interface ICustomEnv {
+    slug: string;
+    base_url?: string;
+    config?: Record<string, unknown>;
+    active: boolean;
+}
+export interface IActionUpdate {
+    resource?: string;
+    method?: HttpMethods;
+    description?: string;
+    request_type?: DataFormats;
+    envs?: ICustomEnv[];
+    response?: {
+        name?: string;
+        tag?: string;
+        success: boolean;
+        body: Record<string, unknown> | string;
+        response_format: DataFormats;
+        status_code: StatusCodes;
+    };
+    body?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    params?: Record<string, unknown>;
+    headers?: Record<string, unknown>;
+}
+export interface IAppAction {
+    _id?: string;
+    app_id?: string;
+    user_id?: string;
+    folder_id?: string;
+    folder_level?: number;
+    description: string;
+    resource: string;
+    name: string;
+    method: HttpMethods;
+    tag: string;
+    request_type: DataFormats;
+    base_url?: string;
+    created?: Date;
+    params?: ISample;
+    query?: ISample;
+    headers?: ISample;
+    envs?: Array<ICustomEnv>;
+    body?: ISample;
+    responses?: Array<IAppActionResponseInfo>;
+}
+export interface IAppFolders {
+    _id: string;
+    name: string;
+    description?: string;
+    parent_id: string | null;
+    level: number;
+}
+export interface IApp {
+    _id?: string;
+    workspace_id?: string;
+    user_id: string;
+    author: string;
+    app_name: string;
+    logo?: string;
+    colors?: {
+        primary?: string;
+        secondary?: string;
+        accent?: string;
+        background?: string;
+    };
+    tag: string;
+    folders?: Array<IAppFolders>;
+    get_started?: number;
+    request_type?: string;
+    description?: string;
+    aboutText?: string;
+    aboutHTML?: string;
+    public_key?: string;
+    private_key?: string;
+    require_whitelist: boolean;
+    versions: Array<IAppVersion>;
+    status?: PublicStates;
+    version?: string;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface IVersion {
+    version: string;
+}
+export interface IAppVersion {
+    tag: string;
+    latest: boolean;
+    envs?: Array<IAppEnv>;
+    folders?: Array<IAppFolders>;
+    description?: string;
+    active: boolean;
+    webhooks?: Array<IAppWebhook>;
+    actions?: Array<IAppAction>;
+    constants?: Array<IAppConstants>;
+    auths?: Array<IAppAuth>;
+    variables?: Array<IAppVariables>;
+    retries: any;
+    actions_count?: number;
+    events_count?: number;
+    auths_count?: number;
+    constants_count?: number;
+    variables_count?: number;
+    envs_count?: number;
+}
+export interface IAppRetryPolicy {
+    max: number;
+    policy: Record<string, IRetrySettings>;
+}
+export interface IRetrySettings {
+    available?: boolean;
+    lag?: number;
+}
+export interface ILoginPayload {
+    email: string;
+    password: string;
+}
+export interface IPrivKeyLoginPayload {
+    accessKey: string;
+}
+export interface IFetchSessionPayload {
+    user_id: string;
+    public_key: string;
+    workspace_id: string;
+}
+export interface IBuilderSessionCreatePayload {
+    private_key?: string;
+    workspace_id: string;
+    user_id: string;
+    public_key: string;
+    token: string;
+}
+export interface IAppNameExistsPayload {
+    workspace_id: string;
+    user_id: string;
+    public_key: string;
+    app_name: string;
+}
+export interface IAppActionExistsPayload {
+    workspace_id: string;
+    user_id: string;
+    tag: string;
+}
+export interface IAppExistsResponse {
+    _id: string;
+}
+export interface IBuilderSession extends IBuilderSessionCreatePayload {
+}
+export interface IUserAuthResponse {
+    auth_token: string;
+    public_key: string;
+    user_id: string;
+    workspace_id: string;
+    active: boolean;
+}
+export interface IFetchAppPayload extends IRequestExtension {
+    app_id: string;
+}
+export interface IAppActionBody extends Omit<IRequestExtension, 'workspace_id'>, IEntityData {
+    app_id?: string;
+    action_id?: string;
+    type: InputsTypes;
+}
+export interface IEntityData {
+    sample: object | string;
+    data?: Array<IParsedSample>;
+}
+export interface Data extends IParsedSample {
+    _id?: string;
+    action_id: string;
+    entity_id?: string;
+    category: Categories;
+    created?: Date;
+}
+export interface ISuccessValues {
+    type: SuccessMarkerType;
+    body: ISample;
+}
+export interface IAppActionResponseInfo {
+    _id?: string;
+    action_id?: string;
+    name: string;
+    tag?: string;
+    response_format: DataFormats;
+    status_code: StatusCodes;
+    success: boolean;
+    type?: InputsTypes;
+    envs?: Array<string>;
+    body: ISample;
+    marker_type?: SuccessMarkerType;
+    success_markers?: Array<IParsedInput>;
+    data?: ISample;
+    success_values?: ISuccessValues;
+    is_status_code_success?: boolean;
+    created?: Date;
+}
+export interface KeyDescription {
+    key: string;
+    description: string;
+}
+export interface ISample extends IEntityData {
+    type: InputsTypes;
+    status_code?: StatusCodes;
+    method?: HttpMethods;
+}
+export interface IAppAuthEnv {
+    _id?: string;
+    setup_id?: string;
+    env_id: string;
+    __v?: number;
+    base_url?: string;
+}
+export interface IAppEventEnv {
+    _id?: string;
+    webhook_id: string;
+    env_id: string;
+    __v?: number;
+}
+export interface IAppVariables {
+    _id?: string;
+    key: string;
+    type: DataTypes;
+    required: boolean;
+    description: string;
+    minlength: number;
+    maxlength: number;
+}
+export interface IAppConstants {
+    _id?: string;
+    key: string;
+    value: string;
+    type: DataTypes;
+    description: string;
+}

package/dist/types/appBuilder.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=appBuilder.types.js.map

package/dist/types/appBuilder.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"appBuilder.types.js","sourceRoot":"","sources":["../../src/types/appBuilder.types.ts"],"names":[],"mappings":""}

package/dist/types/database.types.d.ts

@@ -0,0 +1,9 @@
+import { IParsedSample } from './inputs.types';
+export interface DatabaseActionsHandler {
+    create(schema: IParsedSample[], query: string, params: Record<string, any>, collectionName?: string): Promise<any>;
+    read(schema: IParsedSample[], query: string, params: Record<string, any>, collectionName?: string): Promise<Record<string, unknown>[]>;
+    update(schema: IParsedSample[], query: string, params: Record<string, any>, collectionName?: string, filterSchema?: IParsedSample[], filter?: string, filterOptions?: Record<string, any>): Promise<boolean>;
+    delete(schema: IParsedSample[], query: string, params: Record<string, any>, collectionName?: string): Promise<boolean>;
+    count(schema: IParsedSample[], query: string, params: Record<string, any>, collectionName?: string): Promise<number>;
+    aggregate?(schema: IParsedSample[], query: string, params: Record<string, any>, collectionName?: string): Promise<Record<string, any>>;
+}

package/dist/types/database.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=database.types.js.map

package/dist/types/database.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.types.js","sourceRoot":"","sources":["../../src/types/database.types.ts"],"names":[],"mappings":""}

package/dist/types/enums.d.ts

@@ -0,0 +1,232 @@
+export declare enum PublicStates {
+    ALL = "all",
+    DRAFT = "draft",
+    PRIVATE = "private",
+    PUBLIC = "public"
+}
+export declare enum HttpMethods {
+    POST = "POST",
+    GET = "GET",
+    PUT = "PUT",
+    PATCH = "PATCH",
+    DELETE = "DELETE"
+}
+export declare enum AppComponents {
+    APP = "app",
+    ACTION = "action",
+    EVENT = "event",
+    AUTH = "auth",
+    ENV = "env",
+    CONSTANT = "constants",
+    VARIABLE = "variables",
+    VALIDATION = "validation",
+    ACTION_BULK = "action_bulk",
+    ACTION_RESPONSE = "action_response",
+    WEBHOOK = "webhook",
+    WEBHOOK_EVENT = "webhook_event"
+}
+export declare enum RequestAction {
+    UPDATE = "update",
+    CREATE = "create",
+    DELETE = "delete"
+}
+export declare enum QuotaFallbackTypes {
+    ACTION = "action",
+    FEATURE = "feature"
+}
+export declare enum ProductComponents {
+    ENV = "env",
+    APP = "app",
+    ACTION = "action",
+    DATABASE = "database",
+    FUNCTION = "function",
+    SESSION = "session",
+    CACHE = "cache",
+    NOTIFICATION = "notification",
+    STORAGE = "storage",
+    FEATURE = "feature",
+    JOB = "job",
+    MESSAGEBROKER = "message_broker",
+    MESSAGEBROKER_TOPIC = "message_broker_topic",
+    MESSAGEBROKER_PRODUCER = "message_broker_producer",
+    MESSAGEBROKER_CONSUMER = "message_broker_consumer",
+    DATABASE_ACTION = "database_action",
+    NOTIFICATION_MESSAGE = "notification_message",
+    QUOTA = "quota",
+    CONDITIONAL = "conditional",
+    FALLBACK = "fallback",
+    DATABASE_MIGRATION = "database_migration",
+    HEALTHCHECK = "healthcheck",
+    GRAPH = "graph",
+    WORKFLOW = "workflow",
+    VECTOR = "vector",
+    MODEL = "model",
+    AGENT = "agent",
+    DATABASE_TRIGGER = "database_trigger"
+}
+export declare enum EventTypes {
+    REGISTERED = "registered",
+    CALLBACK = "callback"
+}
+export declare enum AuthTypes {
+    TOKEN = "token_access",// input a token you already have
+    CREDENTIALS = "credential_access"
+}
+export declare enum DataTypes {
+    STRING = "string",
+    NOSPACES_STRING = "nospaces_string",
+    EMAIL_STRING = "email_string",
+    NUMBER_STRING = "number_string",
+    DATE_STRING = "date_string",
+    INTEGER = "number",
+    FLOAT = "float",
+    DOUBLE = "double",
+    UUID = "uuid",
+    DATE = "date",
+    ARRAY = "array",
+    OBJECT = "object",
+    BOOLEAN = "boolean",
+    STRING_ARRAY = "array-string",
+    INTEGER_ARRAY = "array-number",
+    FLOAT_ARRAY = "array-float",
+    DOUBLE_ARRAY = "array-double",
+    UUID_ARRAY = "array-uuid",
+    OBJECT_ARRAY = "array-object",
+    BOOLEAN_ARRAY = "array-boolean",
+    ARRAY_UNDEFINED = "array-undefined"
+}
+export declare enum FileType {
+    BUFFER = "buffer"
+}
+export declare enum AppCategories {
+    BODY = "body",
+    HEADER = "headers",
+    PARAMS = "params",
+    QUERY = "query"
+}
+export declare enum Categories {
+    RESPONSE = "response",
+    BODY = "body",
+    DATA = "data",
+    FILTER = "filter",
+    HEADER = "header",
+    PARAMS = "params",
+    QUERY = "query",
+    INPUT = "input",
+    SETUP = "auth",
+    ACTION = "action",
+    WEBHOOK = "event",
+    CONDITIONAL = "condition"
+}
+export declare enum DefaultTypes {
+    LOOKUP = "lookup",
+    SET = "set",
+    INPUT = "input"
+}
+export declare enum DecoratorPostions {
+    APPEND = "AFTER",
+    PREPEND = "BEFORE",
+    UNSET = ""
+}
+export declare enum InputsTypes {
+    JSON = "json",
+    XML = "xml",
+    HTML = "html",
+    PLAIN = "plain",
+    TEXT = "text",
+    JAVASCRIPT = "javascript",
+    URLENCODED = "urlencoded",
+    FORMDATA = "form-data"
+}
+export declare enum SuccessMarkerType {
+    VALUE = "value",// We should expect the keys to equal a value
+    KEY = "key"
+}
+export declare enum StatusCodes {
+    CONTINUE = "100",
+    SWITCHING = "101",
+    PROCESSING = "102",
+    EARLY_HINTS = "103",
+    OK = "200",
+    CREATED = "201",
+    ACCEPTED = "202",
+    NON_AUTHORIZED = "203",
+    NO_CONTENT = "204",
+    RESET_CONTENT = "205",
+    PARTIAL_CONTENT = "206",
+    MULTI_STATUS = "207",
+    ALREADY_REPORTED = "208",
+    IM_USED = "226",
+    MULTIPLECHOICES = "300",
+    MOVED_PERMANENTLY = "301",
+    FOUND = "302",
+    SEE_OTHER = "303",
+    NOT_MODIFIED = "304",
+    USE_PROXY = "305",
+    UNUSED = "306",
+    TEMPORARY_REDIRECT = "307",
+    PERMANENT_REDIRECT = "308",
+    BAD_REQUEST = "400",
+    UNAUTHORIZED = "401",
+    PAYMENT_REQUIRED = "402",
+    FORBIDDEN = "403",
+    NOT_FOUND = "404",
+    NOT_ALLOWED = "405",
+    NOT_ACCEPTABLE = "406",
+    PROXY_AUTH_REQUIRED = "407",
+    REQUEST_TIMEOUT = "408",
+    CONFLICT = "409",
+    GONE = "410",
+    LENGTH_REQUIRED = "411",
+    PRECONDITION_FAILED = "412",
+    PAYLOAD_TOO_LARGE = "413",
+    URI_TOO_LONG = "414",
+    UNSUPPORTED_MEDIA_TYPE = "415",
+    RANGE_NOT_SATISFIABLE = "416",
+    EXPECTATION_FAILED = "417",
+    TEAPOT = "418",
+    MISDIRECTED_REQUEST = "421",
+    UNPROCESSABLE_ENTITY = "422",
+    LOCKED = "423",
+    TOO_EARLY = "425",
+    FAILED_DEPENDENCY = "424",
+    UPGRADE_REQUIRED = "426",
+    PRECONDITION_REQUIRED = "428",
+    TOO_MANY_REQUESTS = "429",
+    HEADER_TOO_LARGE = "431",
+    LEGAL_EXCEPTION = "451",
+    INTERNAL_SERVER_ERROR = "500",
+    NOT_IMPLEMENTED = "501",
+    BAD_GATEWAY = "502",
+    SERVICE_UNAVAILABLE = "503",
+    GATEWAY_TIMEOUT = "504",
+    HTTP_VERSION_NOT_SUPPORTED = "505",
+    VARIANT_ALSO_NEGOTIATES = "506",
+    INSUFFICIENT_STORAGE = "507",
+    LOOP_DETECTED = "508",
+    NOT_EXTENDED = "510",
+    NETWORK_AUTH_REQUIRED = "511"
+}
+export declare enum DataFormats {
+    JSON = "application/json",
+    URLENCODED = "application/x-www-form-urlencoded",
+    FORMDATA = "multipart/form-data",
+    SOAP = "SOAP",
+    HTML = "html"
+}
+export declare enum TokenPeriods {
+    HOURS = "hours",
+    MINUTES = "mins",
+    SECONDS = "secs",
+    DAYS = "days",
+    WEEKS = "weeks",
+    MONTHS = "months",
+    YEARS = "years"
+}
+export declare enum Languages {
+    JAVASCRIPT = "js"
+}
+export declare enum Notifiers {
+    FIREBASE = "firebase",
+    EXPO = "expo"
+}