@devrev/typescript-sdk 1.1.25 → 1.1.27

package/dist/snap-ins/struct.pb.js

@@ -0,0 +1,491 @@
+"use strict";
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.176.0
+//   protoc               v4.25.2
+// source: google/protobuf/struct.proto
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListValue = exports.Value = exports.Struct_FieldsEntry = exports.Struct = exports.nullValueToJSON = exports.nullValueFromJSON = exports.NullValue = exports.protobufPackage = void 0;
+/* eslint-disable */
+const _m0 = __importStar(require("protobufjs/minimal"));
+exports.protobufPackage = 'google.protobuf';
+/**
+ * `NullValue` is a singleton enumeration to represent the null value for the
+ * `Value` type union.
+ *
+ * The JSON representation for `NullValue` is JSON `null`.
+ */
+var NullValue;
+(function (NullValue) {
+    /** NULL_VALUE - Null value. */
+    NullValue[NullValue["NULL_VALUE"] = 0] = "NULL_VALUE";
+    NullValue[NullValue["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+})(NullValue = exports.NullValue || (exports.NullValue = {}));
+function nullValueFromJSON(object) {
+    switch (object) {
+        case 0:
+        case 'NULL_VALUE':
+            return NullValue.NULL_VALUE;
+        case -1:
+        case 'UNRECOGNIZED':
+        default:
+            return NullValue.UNRECOGNIZED;
+    }
+}
+exports.nullValueFromJSON = nullValueFromJSON;
+function nullValueToJSON(object) {
+    switch (object) {
+        case NullValue.NULL_VALUE:
+            return 'NULL_VALUE';
+        case NullValue.UNRECOGNIZED:
+        default:
+            return 'UNRECOGNIZED';
+    }
+}
+exports.nullValueToJSON = nullValueToJSON;
+function createBaseStruct() {
+    return { fields: {} };
+}
+exports.Struct = {
+    encode(message, writer = _m0.Writer.create()) {
+        Object.entries(message.fields).forEach(([key, value]) => {
+            if (value !== undefined) {
+                exports.Struct_FieldsEntry.encode({ key: key, value }, writer.uint32(10).fork()).ldelim();
+            }
+        });
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseStruct();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    const entry1 = exports.Struct_FieldsEntry.decode(reader, reader.uint32());
+                    if (entry1.value !== undefined) {
+                        message.fields[entry1.key] = entry1.value;
+                    }
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            fields: isObject(object.fields)
+                ? Object.entries(object.fields).reduce((acc, [key, value]) => {
+                    acc[key] = value;
+                    return acc;
+                }, {})
+                : {},
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.fields) {
+            const entries = Object.entries(message.fields);
+            if (entries.length > 0) {
+                obj.fields = {};
+                entries.forEach(([k, v]) => {
+                    obj.fields[k] = v;
+                });
+            }
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.Struct.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a;
+        const message = createBaseStruct();
+        message.fields = Object.entries((_a = object.fields) !== null && _a !== void 0 ? _a : {}).reduce((acc, [key, value]) => {
+            if (value !== undefined) {
+                acc[key] = value;
+            }
+            return acc;
+        }, {});
+        return message;
+    },
+    wrap(object) {
+        const struct = createBaseStruct();
+        if (object !== undefined) {
+            for (const key of Object.keys(object)) {
+                struct.fields[key] = object[key];
+            }
+        }
+        return struct;
+    },
+    unwrap(message) {
+        const object = {};
+        if (message.fields) {
+            for (const key of Object.keys(message.fields)) {
+                object[key] = message.fields[key];
+            }
+        }
+        return object;
+    },
+};
+function createBaseStruct_FieldsEntry() {
+    return { key: '', value: undefined };
+}
+exports.Struct_FieldsEntry = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.key !== '') {
+            writer.uint32(10).string(message.key);
+        }
+        if (message.value !== undefined) {
+            exports.Value.encode(exports.Value.wrap(message.value), writer.uint32(18).fork()).ldelim();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseStruct_FieldsEntry();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.key = reader.string();
+                    continue;
+                case 2:
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.value = exports.Value.unwrap(exports.Value.decode(reader, reader.uint32()));
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            key: isSet(object.key) ? globalThis.String(object.key) : '',
+            value: isSet(object === null || object === void 0 ? void 0 : object.value) ? object.value : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.key !== '') {
+            obj.key = message.key;
+        }
+        if (message.value !== undefined) {
+            obj.value = message.value;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.Struct_FieldsEntry.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a, _b;
+        const message = createBaseStruct_FieldsEntry();
+        message.key = (_a = object.key) !== null && _a !== void 0 ? _a : '';
+        message.value = (_b = object.value) !== null && _b !== void 0 ? _b : undefined;
+        return message;
+    },
+};
+function createBaseValue() {
+    return {
+        null_value: undefined,
+        number_value: undefined,
+        string_value: undefined,
+        bool_value: undefined,
+        struct_value: undefined,
+        list_value: undefined,
+    };
+}
+exports.Value = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.null_value !== undefined) {
+            writer.uint32(8).int32(message.null_value);
+        }
+        if (message.number_value !== undefined) {
+            writer.uint32(17).double(message.number_value);
+        }
+        if (message.string_value !== undefined) {
+            writer.uint32(26).string(message.string_value);
+        }
+        if (message.bool_value !== undefined) {
+            writer.uint32(32).bool(message.bool_value);
+        }
+        if (message.struct_value !== undefined) {
+            exports.Struct.encode(exports.Struct.wrap(message.struct_value), writer.uint32(42).fork()).ldelim();
+        }
+        if (message.list_value !== undefined) {
+            exports.ListValue.encode(exports.ListValue.wrap(message.list_value), writer.uint32(50).fork()).ldelim();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseValue();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 8) {
+                        break;
+                    }
+                    message.null_value = reader.int32();
+                    continue;
+                case 2:
+                    if (tag !== 17) {
+                        break;
+                    }
+                    message.number_value = reader.double();
+                    continue;
+                case 3:
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.string_value = reader.string();
+                    continue;
+                case 4:
+                    if (tag !== 32) {
+                        break;
+                    }
+                    message.bool_value = reader.bool();
+                    continue;
+                case 5:
+                    if (tag !== 42) {
+                        break;
+                    }
+                    message.struct_value = exports.Struct.unwrap(exports.Struct.decode(reader, reader.uint32()));
+                    continue;
+                case 6:
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.list_value = exports.ListValue.unwrap(exports.ListValue.decode(reader, reader.uint32()));
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            null_value: isSet(object.null_value)
+                ? nullValueFromJSON(object.null_value)
+                : undefined,
+            number_value: isSet(object.number_value)
+                ? globalThis.Number(object.number_value)
+                : undefined,
+            string_value: isSet(object.string_value)
+                ? globalThis.String(object.string_value)
+                : undefined,
+            bool_value: isSet(object.bool_value)
+                ? globalThis.Boolean(object.bool_value)
+                : undefined,
+            struct_value: isObject(object.struct_value)
+                ? object.struct_value
+                : undefined,
+            list_value: globalThis.Array.isArray(object.list_value)
+                ? [...object.list_value]
+                : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.null_value !== undefined) {
+            obj.null_value = nullValueToJSON(message.null_value);
+        }
+        if (message.number_value !== undefined) {
+            obj.number_value = message.number_value;
+        }
+        if (message.string_value !== undefined) {
+            obj.string_value = message.string_value;
+        }
+        if (message.bool_value !== undefined) {
+            obj.bool_value = message.bool_value;
+        }
+        if (message.struct_value !== undefined) {
+            obj.struct_value = message.struct_value;
+        }
+        if (message.list_value !== undefined) {
+            obj.list_value = message.list_value;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.Value.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a, _b, _c, _d, _e, _f;
+        const message = createBaseValue();
+        message.null_value = (_a = object.null_value) !== null && _a !== void 0 ? _a : undefined;
+        message.number_value = (_b = object.number_value) !== null && _b !== void 0 ? _b : undefined;
+        message.string_value = (_c = object.string_value) !== null && _c !== void 0 ? _c : undefined;
+        message.bool_value = (_d = object.bool_value) !== null && _d !== void 0 ? _d : undefined;
+        message.struct_value = (_e = object.struct_value) !== null && _e !== void 0 ? _e : undefined;
+        message.list_value = (_f = object.list_value) !== null && _f !== void 0 ? _f : undefined;
+        return message;
+    },
+    wrap(value) {
+        const result = createBaseValue();
+        if (value === null) {
+            result.null_value = NullValue.NULL_VALUE;
+        }
+        else if (typeof value === 'boolean') {
+            result.bool_value = value;
+        }
+        else if (typeof value === 'number') {
+            result.number_value = value;
+        }
+        else if (typeof value === 'string') {
+            result.string_value = value;
+        }
+        else if (globalThis.Array.isArray(value)) {
+            result.list_value = value;
+        }
+        else if (typeof value === 'object') {
+            result.struct_value = value;
+        }
+        else if (typeof value !== 'undefined') {
+            throw new globalThis.Error('Unsupported any value type: ' + typeof value);
+        }
+        return result;
+    },
+    unwrap(message) {
+        if (message.string_value !== undefined) {
+            return message.string_value;
+        }
+        else if ((message === null || message === void 0 ? void 0 : message.number_value) !== undefined) {
+            return message.number_value;
+        }
+        else if ((message === null || message === void 0 ? void 0 : message.bool_value) !== undefined) {
+            return message.bool_value;
+        }
+        else if ((message === null || message === void 0 ? void 0 : message.struct_value) !== undefined) {
+            return message.struct_value;
+        }
+        else if ((message === null || message === void 0 ? void 0 : message.list_value) !== undefined) {
+            return message.list_value;
+        }
+        else if ((message === null || message === void 0 ? void 0 : message.null_value) !== undefined) {
+            return null;
+        }
+        return undefined;
+    },
+};
+function createBaseListValue() {
+    return { values: [] };
+}
+exports.ListValue = {
+    encode(message, writer = _m0.Writer.create()) {
+        for (const v of message.values) {
+            exports.Value.encode(exports.Value.wrap(v), writer.uint32(10).fork()).ldelim();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseListValue();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.values.push(exports.Value.unwrap(exports.Value.decode(reader, reader.uint32())));
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            values: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.values)
+                ? [...object.values]
+                : [],
+        };
+    },
+    toJSON(message) {
+        var _a;
+        const obj = {};
+        if ((_a = message.values) === null || _a === void 0 ? void 0 : _a.length) {
+            obj.values = message.values;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.ListValue.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a;
+        const message = createBaseListValue();
+        message.values = ((_a = object.values) === null || _a === void 0 ? void 0 : _a.map((e) => e)) || [];
+        return message;
+    },
+    wrap(array) {
+        const result = createBaseListValue();
+        result.values = array !== null && array !== void 0 ? array : [];
+        return result;
+    },
+    unwrap(message) {
+        if ((message === null || message === void 0 ? void 0 : message.hasOwnProperty('values')) &&
+            globalThis.Array.isArray(message.values)) {
+            return message.values;
+        }
+        else {
+            return message;
+        }
+    },
+};
+function isObject(value) {
+    return typeof value === 'object' && value !== null;
+}
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

package/dist/snap-ins/types.d.ts

@@ -0,0 +1,166 @@
+import { WebhookEventRequest } from '../auto-generated/public-devrev-sdk';
+import { OperationIfc } from './interfaces';
+import { ExecuteOperationInput } from './schema.pb';
+/**
+ * The context object contains information about the execution environment and the snap-in.
+ */
+export type Context = {
+    /**
+     * ID of the DevOrg for which the function is being invoked.
+     */
+    dev_oid: string;
+    /**
+     * ID of the Automation/Command/SnapKit Action/Event Source for which the function is being invoked.
+     */
+    source_id: string;
+    /**
+     * ID of the Snap-in as part of which the function is being invoked.
+     */
+    snap_in_id: string;
+    /**
+     * ID of the Snap-in version as part of which the function is being invoked.
+     */
+    snap_in_version_id: string;
+    /**
+     * The ID of the service account associated with the snap-in.
+     */
+    service_account_id: string;
+    /**
+     * This secrets map would contain some secrets which platform would provide to the snap-in.
+     * `service_account_token`: This is the token of the service account which belongs to this snap-in. This can be used to make API calls to DevRev.
+     * `actor_session_token`: For commands, and snap-kits, where the user is performing some action, this is the token of the user who is performing the action.
+     */
+    secrets: Record<string, string>;
+};
+/**
+ * Metadata about the execution of the function.
+ */
+export type ExecutionMetadata = {
+    /**
+     * A unique id for the function invocation. Can be used to filter logs for a particular invocation.
+     */
+    request_id: string;
+    /**
+     * Function name as defined in the manifest being invoked.
+     */
+    function_name: string;
+    /**
+     * Type of event that triggered the function invocation as defined in manifest.
+     */
+    event_type: string;
+    /**
+     * DevRev endpoint to which the function can make API calls.
+     * @example
+     * "https://api.devrev.ai/"
+     */
+    devrev_endpoint: string;
+};
+/**
+ * Input data provided to the function.
+ */
+export type InputData = {
+    /**
+     * Map of globals and their corresponding values stored in Snap-in.
+     * The values are passed as string and typing need to be handled by the function
+     */
+    global_values: Record<string, string>;
+    /**
+     * Map of event sources and their corresponding ids stored in Snap-in.
+     * These could be used to schedule events on a schedule based event source.
+     */
+    event_sources: Record<string, string>;
+    /**
+     * Map of resources stored in the Snap-in. The resources include keyrings and tags.
+     * The key is the resource name defined in manifest and value is the resource object.
+     */
+    resources?: Record<string, any>;
+};
+/**
+ * The input object received by the function.
+ */
+export type FunctionInput = {
+    /**
+     * Actual payload of the event. WebhookEventRequest if event souce is `devrev-webhooks`; otherwise, a record of event data.
+     */
+    payload: WebhookEventRequest | Record<string, any> | ExecuteOperationInput;
+    /**
+     * Context of the function invocation.
+     */
+    context: Context;
+    /**
+     * Metadata of the function invocation.
+     */
+    execution_metadata: ExecutionMetadata;
+    /**
+     * Input data provided to the function.
+     */
+    input_data: InputData;
+};
+/**
+ * Return type for hooks.
+ */
+export interface HookResult {
+    /**
+     * Updated input values returned from hooks function execution
+     */
+    inputs_values: Record<string, string>;
+}
+/**
+ *  Metadata about the operation context. This is passed to the operation function as an argument.
+ */
+export type OperationContext = {
+    /**
+     * DevRev endpoint to which the function can make API calls.
+     * @example
+     * "https://api.devrev.ai/"
+     */
+    devrev_endpoint: string;
+    /**
+     * This secrets map would contain some secrets which platform would provide to the snap-in.
+     * `access_token`: Access token of the user invoking this operation.
+     */
+    secrets: OperationContextSecrets;
+    /**
+     * ID of the DevOrg for which the function is being invoked.
+     */
+    dev_oid: string;
+    /**
+     * Name of the input port.
+     */
+    input_port: string;
+    /**
+     * Additional metadata that the developer can pass to the Operation.
+     */
+    metadata?: Record<string, any>;
+};
+export type OperationContextSecrets = {
+    /**
+     * Access token of the user invoking this operation.
+     */
+    access_token: string;
+};
+/**
+ * Map of operation slug to operation class.
+ */
+export type OperationMap = {
+    [slug: string]: new (e: any) => OperationIfc;
+};
+/**
+ * Error instance type to be thrown when an error occurs in the snap-in. The
+ * error type is used to determine if the event should be retried or not.
+ */
+export declare class FunctionExecutionError extends Error {
+    /**
+     * Toggle to determine if the event should be retried or not. If not set or set to false,
+     * the event will not be retried.
+     */
+    retry: boolean;
+    /**
+     * Whether to retry the event payload with updated metadata
+     * that platform provides. Useful when the event payload is
+     * not in a state to be directly processed, and may need new
+     * keyrings/service account tokens or new inputs.
+     */
+    refresh?: boolean;
+    constructor(message: string, retry: boolean, refresh?: boolean);
+}

package/dist/snap-ins/types.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FunctionExecutionError = void 0;
+/**
+ * Error instance type to be thrown when an error occurs in the snap-in. The
+ * error type is used to determine if the event should be retried or not.
+ */
+class FunctionExecutionError extends Error {
+    constructor(message, retry, refresh) {
+        super(message);
+        this.retry = retry;
+        this.refresh = refresh;
+    }
+}
+exports.FunctionExecutionError = FunctionExecutionError;

package/dist/snap-ins/types.test.d.ts

@@ -0,0 +1 @@
+export {};