@useparagon/cli 0.0.1-canary.1

package/sample/sample.js

@@ -0,0 +1,404 @@
+module.exports.samplebuild = {
+  events: {
+    '4d26c381-fb4a-4a20-b95d-bacd4acd4291': {
+      id: '4d26c381-fb4a-4a20-b95d-bacd4acd4291',
+      name: 'hello',
+      schema: {
+        message: 'Hellow world',
+      },
+    },
+    '1a41436a-2e4d-4c12-8e32-16a408938fd3': {
+      id: '1a41436a-2e4d-4c12-8e32-16a408938fd3',
+      name: 'hello',
+      schema: {
+        message: 'Hello, World!',
+        nested: {
+          value: {
+            count: 20,
+          },
+        },
+      },
+    },
+  },
+  integrations: {
+    'custom.dummyJson': {
+      config: {
+        default: {
+          description: 'A dummy BYO integration.',
+          overviewText:
+            'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n  \n  Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\n  \n  Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.\n  \n  Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.',
+          scopes: 'user:read',
+        },
+      },
+      workflows: {
+        '4d26c381-fb4a-4a20-b95d-bacd4acd4291': {
+          id: '4d26c381-fb4a-4a20-b95d-bacd4acd4291',
+          name: '01-simple-event',
+          stateMachine: {
+            stepMap: {
+              'b11b1604-a39a-442b-8963-721e6c9bb747': {
+                id: 'b11b1604-a39a-442b-8963-721e6c9bb747',
+                dateCreated: '2023-11-01T13:54:18.081Z',
+                dateUpdated: '2023-11-01T13:56:44.972Z',
+                description: 'description',
+                type: 'TRANSITION/IFELSE',
+                parameters: {
+                  choices: [
+                    {
+                      next: null,
+                      label: 'Yes',
+                      isDefault: false,
+                      conditionWrapper: {
+                        join: 'OR',
+                        type: 'JOIN',
+                        conditions: [
+                          {
+                            join: 'AND',
+                            type: 'JOIN',
+                            conditions: [
+                              {
+                                type: 'OPERATOR',
+                                condition: {
+                                  operator: '$booleanTrue',
+                                  variable: {
+                                    path: ['result', 'num'],
+                                    type: 'VARIABLE',
+                                    stepId:
+                                      '6c7c9bbc-f33e-4e7e-8226-47d18fcdf361',
+                                    dataType: 'BOOLEAN',
+                                  },
+                                },
+                              },
+                              {
+                                type: 'OPERATOR',
+                                condition: {
+                                  argument: {
+                                    type: 'VALUE',
+                                    value: 'paragon',
+                                    dataType: 'STRING',
+                                  },
+                                  operator: '$stringContains',
+                                  variable: {
+                                    path: ['result', 'str'],
+                                    type: 'VARIABLE',
+                                    stepId:
+                                      '6c7c9bbc-f33e-4e7e-8226-47d18fcdf361',
+                                    dataType: 'STRING',
+                                  },
+                                },
+                              },
+                            ],
+                          },
+                        ],
+                      },
+                    },
+                    {
+                      next: '2f7edb3f-1b58-4b80-be08-67f85ed6afea',
+                      label: 'No',
+                      isDefault: true,
+                    },
+                  ],
+                },
+                next: 'd4f2bf7d-4610-4625-9314-02c9be9dc43b',
+                status: 'INVALID',
+                workflowId: 'c3000c95-82cf-4814-b4c2-2cb2c4b89bbc',
+              },
+              '2f7edb3f-1b58-4b80-be08-67f85ed6afea': {
+                id: '2f7edb3f-1b58-4b80-be08-67f85ed6afea',
+                dateCreated: '2023-11-01T13:56:41.950Z',
+                dateUpdated: '2023-11-01T13:57:03.174Z',
+                description: 'description',
+                type: 'ACTION/FUNCTION',
+                parameters: {
+                  code: 'function yourFunction(parameters, libraries) {\nreturn [1,2,3]\n}',
+                  parameters: [],
+                },
+                next: '82f21fb0-e712-4cb8-b2ec-70fa0ffc5568',
+                status: 'INVALID',
+                workflowId: 'c3000c95-82cf-4814-b4c2-2cb2c4b89bbc',
+              },
+              '82f21fb0-e712-4cb8-b2ec-70fa0ffc5568': {
+                id: '82f21fb0-e712-4cb8-b2ec-70fa0ffc5568',
+                dateCreated: '2023-11-01T13:57:00.178Z',
+                dateUpdated: '2023-11-01T13:57:14.448Z',
+                description: 'description',
+                type: 'TRANSITION/MAP',
+                parameters: {
+                  iterator: {
+                    path: ['result'],
+                    type: 'VARIABLE',
+                    stepId: '2f7edb3f-1b58-4b80-be08-67f85ed6afea',
+                    dataType: 'ARRAY',
+                  },
+                  nextToIterate: 'd9c96e6e-9a34-4c6c-8428-578023056934',
+                },
+                next: null,
+                status: 'INVALID',
+                workflowId: 'c3000c95-82cf-4814-b4c2-2cb2c4b89bbc',
+              },
+              'd4f2bf7d-4610-4625-9314-02c9be9dc43b': {
+                id: 'd4f2bf7d-4610-4625-9314-02c9be9dc43b',
+                dateCreated: '2023-11-01T13:56:32.611Z',
+                dateUpdated: '2023-11-01T13:56:32.611Z',
+                description: 'description',
+                type: 'ACTION/RESPONSE',
+                parameters: {
+                  bodyData: [],
+                  statusCode: 200,
+                  responseType: 'JSON',
+                },
+                next: null,
+                status: 'INVALID',
+                workflowId: 'c3000c95-82cf-4814-b4c2-2cb2c4b89bbc',
+              },
+              'd9c96e6e-9a34-4c6c-8428-578023056934': {
+                id: 'd9c96e6e-9a34-4c6c-8428-578023056934',
+                dateCreated: '2023-11-01T13:57:14.448Z',
+                dateUpdated: '2023-11-01T13:57:14.448Z',
+                description: 'description',
+                type: 'ACTION/FUNCTION',
+                parameters: {
+                  code: 'function yourFunction(parameters, libraries) {\nreturn "success"\n}',
+                  parameters: [],
+                },
+                next: null,
+                status: 'INVALID',
+                workflowId: 'c3000c95-82cf-4814-b4c2-2cb2c4b89bbc',
+              },
+              '22e7f997-de29-410d-be06-7b87fbfbd77b': {
+                id: '22e7f997-de29-410d-be06-7b87fbfbd77b',
+                dateCreated: '2023-11-01T13:53:20.128Z',
+                dateUpdated: '2023-11-01T13:53:35.597Z',
+                description: 'Trigger',
+                type: 'TRIGGER/CRON',
+                parameters: {
+                  schedule: {
+                    unit: 'MINUTES',
+                    minutes: 10,
+                  },
+                },
+                next: '6c7c9bbc-f33e-4e7e-8226-47d18fcdf361',
+                status: 'INVALID',
+                workflowId: 'c3000c95-82cf-4814-b4c2-2cb2c4b89bbc',
+              },
+              '6c7c9bbc-f33e-4e7e-8226-47d18fcdf361': {
+                id: '6c7c9bbc-f33e-4e7e-8226-47d18fcdf361',
+                dateCreated: '2023-11-01T13:53:32.531Z',
+                dateUpdated: '2023-11-01T13:54:58.249Z',
+                description: 'description',
+                type: 'ACTION/FUNCTION',
+                parameters: {
+                  code: 'function yourFunction(parameters, libraries) {\nreturn {\n    num:4,\n    str:"paragon"\n}\n}',
+                  parameters: [],
+                },
+                next: '99d371fd-608f-4785-b4c8-a361f595e7c9',
+                status: 'INVALID',
+                workflowId: 'c3000c95-82cf-4814-b4c2-2cb2c4b89bbc',
+              },
+              '99d371fd-608f-4785-b4c8-a361f595e7c9': {
+                id: '99d371fd-608f-4785-b4c8-a361f595e7c9',
+                dateCreated: '2023-11-01T13:54:01.396Z',
+                dateUpdated: '2023-11-01T13:55:08.164Z',
+                description: 'description',
+                type: 'ACTION/DELAY',
+                parameters: {
+                  unit: 'HOURS',
+                  value: {
+                    path: ['result', 'num'],
+                    type: 'VARIABLE',
+                    stepId: '6c7c9bbc-f33e-4e7e-8226-47d18fcdf361',
+                    dataType: 'NON_DECIMAL',
+                  },
+                },
+                next: 'b11b1604-a39a-442b-8963-721e6c9bb747',
+                status: 'INVALID',
+                workflowId: 'c3000c95-82cf-4814-b4c2-2cb2c4b89bbc',
+              },
+            },
+            sequenceMap: {
+              'sequence-0': {
+                id: 'sequence-0',
+                start: '22e7f997-de29-410d-be06-7b87fbfbd77b',
+                stepIds: ['22e7f997-de29-410d-be06-7b87fbfbd77b'],
+                stepEdges: [
+                  {
+                    from: '22e7f997-de29-410d-be06-7b87fbfbd77b',
+                    to: '6c7c9bbc-f33e-4e7e-8226-47d18fcdf361',
+                  },
+                ],
+                sequenceEdges: [
+                  {
+                    type: 'NEXT',
+                    from: 'sequence-0',
+                    to: 'sequence-1',
+                  },
+                ],
+                type: 'TRIGGER',
+                conditionalBranchWidth: 0,
+              },
+              'sequence-1': {
+                id: 'sequence-1',
+                start: '6c7c9bbc-f33e-4e7e-8226-47d18fcdf361',
+                stepIds: [
+                  '6c7c9bbc-f33e-4e7e-8226-47d18fcdf361',
+                  '99d371fd-608f-4785-b4c8-a361f595e7c9',
+                ],
+                stepEdges: [
+                  {
+                    from: '6c7c9bbc-f33e-4e7e-8226-47d18fcdf361',
+                    to: '99d371fd-608f-4785-b4c8-a361f595e7c9',
+                  },
+                  {
+                    from: '99d371fd-608f-4785-b4c8-a361f595e7c9',
+                    to: 'b11b1604-a39a-442b-8963-721e6c9bb747',
+                  },
+                ],
+                sequenceEdges: [
+                  {
+                    type: 'NEXT',
+                    from: 'sequence-1',
+                    to: 'sequence-2',
+                  },
+                ],
+                type: 'MAIN',
+                conditionalBranchWidth: 0,
+              },
+              'sequence-2': {
+                id: 'sequence-2',
+                start: 'b11b1604-a39a-442b-8963-721e6c9bb747',
+                stepIds: ['b11b1604-a39a-442b-8963-721e6c9bb747'],
+                stepEdges: [
+                  {
+                    from: 'b11b1604-a39a-442b-8963-721e6c9bb747',
+                    to: 'd4f2bf7d-4610-4625-9314-02c9be9dc43b',
+                  },
+                  {
+                    label: 'Yes',
+                    from: 'b11b1604-a39a-442b-8963-721e6c9bb747',
+                    to: null,
+                  },
+                  {
+                    label: 'No',
+                    from: 'b11b1604-a39a-442b-8963-721e6c9bb747',
+                    to: '2f7edb3f-1b58-4b80-be08-67f85ed6afea',
+                  },
+                ],
+                sequenceEdges: [
+                  {
+                    type: 'BRANCH',
+                    from: 'sequence-2',
+                    to: 'sequence-3',
+                  },
+                  {
+                    type: 'BRANCH',
+                    from: 'sequence-2',
+                    to: 'sequence-4',
+                  },
+                  {
+                    type: 'NEXT',
+                    from: 'sequence-2',
+                    to: 'sequence-8',
+                  },
+                ],
+                type: 'MAIN',
+                conditionalBranchWidth: 1.5,
+              },
+              'sequence-3': {
+                id: 'sequence-3',
+                stepIds: [],
+                stepEdges: [],
+                sequenceEdges: [],
+                type: 'BRANCH',
+                conditionalBranchWidth: 0,
+              },
+              'sequence-4': {
+                id: 'sequence-4',
+                start: '2f7edb3f-1b58-4b80-be08-67f85ed6afea',
+                stepIds: ['2f7edb3f-1b58-4b80-be08-67f85ed6afea'],
+                stepEdges: [
+                  {
+                    from: '2f7edb3f-1b58-4b80-be08-67f85ed6afea',
+                    to: '82f21fb0-e712-4cb8-b2ec-70fa0ffc5568',
+                  },
+                ],
+                sequenceEdges: [
+                  {
+                    type: 'NEXT',
+                    from: 'sequence-4',
+                    to: 'sequence-5',
+                  },
+                ],
+                type: 'BRANCH',
+                conditionalBranchWidth: 0,
+              },
+              'sequence-5': {
+                id: 'sequence-5',
+                start: '82f21fb0-e712-4cb8-b2ec-70fa0ffc5568',
+                stepIds: ['82f21fb0-e712-4cb8-b2ec-70fa0ffc5568'],
+                stepEdges: [
+                  {
+                    from: '82f21fb0-e712-4cb8-b2ec-70fa0ffc5568',
+                    to: null,
+                  },
+                ],
+                sequenceEdges: [
+                  {
+                    type: 'FANOUT',
+                    from: 'sequence-5',
+                    to: 'sequence-6',
+                  },
+                  {
+                    type: 'NEXT',
+                    from: 'sequence-5',
+                    to: 'sequence-7',
+                  },
+                ],
+                type: 'BRANCH',
+                conditionalBranchWidth: 0.5,
+              },
+              'sequence-6': {
+                id: 'sequence-6',
+                start: 'd9c96e6e-9a34-4c6c-8428-578023056934',
+                stepIds: ['d9c96e6e-9a34-4c6c-8428-578023056934'],
+                stepEdges: [
+                  {
+                    from: 'd9c96e6e-9a34-4c6c-8428-578023056934',
+                    to: null,
+                  },
+                ],
+                sequenceEdges: [],
+                type: 'FANOUT',
+                conditionalBranchWidth: 0,
+              },
+              'sequence-7': {
+                id: 'sequence-7',
+                stepIds: [],
+                stepEdges: [],
+                sequenceEdges: [],
+                type: 'MAIN',
+                conditionalBranchWidth: 0,
+              },
+              'sequence-8': {
+                id: 'sequence-8',
+                start: 'd4f2bf7d-4610-4625-9314-02c9be9dc43b',
+                stepIds: ['d4f2bf7d-4610-4625-9314-02c9be9dc43b'],
+                stepEdges: [
+                  {
+                    from: 'd4f2bf7d-4610-4625-9314-02c9be9dc43b',
+                    to: null,
+                  },
+                ],
+                sequenceEdges: [],
+                type: 'MAIN',
+                conditionalBranchWidth: 0,
+              },
+            },
+            start: 'sequence-0',
+            activeStepId: '22e7f997-de29-410d-be06-7b87fbfbd77b',
+            unusedSteps: [],
+          },
+        },
+      },
+    },
+  },
+};

package/src/codegen/codegen.types.ts

@@ -0,0 +1,14 @@
+import { IEvent } from '@useparagon/core/event';
+
+/**
+ * integration depdencies
+ */
+export type ProjectDependencies = {
+  events: Record<string, IEvent>;
+};
+
+export type WorkflowDependencies = ProjectDependencies & {
+  integration: {
+    name: string;
+  };
+};

package/src/codegen/codegen.utils.ts

@@ -0,0 +1,145 @@
+import * as importSortOrderPlugin from '@trivago/prettier-plugin-sort-imports';
+import fs from 'fs-extra';
+import path from 'path';
+import prettier from 'prettier';
+import * as organiseImportPlugin from 'prettier-plugin-organize-imports';
+
+import { IEvent } from '@useparagon/core/event';
+
+import {
+  BuildOutput,
+  IntegrationOutput,
+  WorkflowOutput,
+  ProjectDependencies,
+} from '../compilers/compiler.types';
+import { eventToCode } from './codegens/event.codegen';
+import { integrationConfigToCode } from './codegens/integration.codegen';
+import { workflowToCode } from './codegens/workflow.codegen';
+
+/**
+ * write code in file
+ * @param filePath
+ * @param fileName
+ * @param sourceCode
+ */
+const writeSourceToFile = async (
+  filePath: string,
+  fileName: string,
+  sourceCode: string,
+): Promise<void> => {
+  const sanitizeFileName: string = fileName;
+
+  const formattedCode: string = prettier.format(sourceCode, {
+    parser: 'typescript',
+    semi: true,
+    trailingComma: 'all',
+    singleQuote: true,
+    plugins: [organiseImportPlugin, importSortOrderPlugin],
+    //@ts-ignore plugin specific config
+    importOrder: ['^@useparagon/(.*)$', '^[./]'],
+    importOrderSeparation: true,
+    importOrderCaseInsensitive: true,
+  });
+
+  await fs.promises.writeFile(
+    path.join(filePath, `${sanitizeFileName}.ts`),
+    formattedCode,
+  );
+};
+
+/**
+ * wrap multiline string value with template string
+ * @param value
+ * @returns
+ */
+export const wrapMultilineString = (value: string): string => {
+  return '`' + value + '`';
+};
+
+/**
+ * generate all source files for integration
+ * @param integrationOutput
+ * @param ProjectDependencies
+ * @param projectRoot
+ */
+export const generateIntegrationFiles = async (
+  integrationName: string,
+  integrationOutput: IntegrationOutput,
+  projectDependencies: ProjectDependencies,
+  projectRoot: string,
+) => {
+  const integrationPath: string = path.join(
+    projectRoot,
+    'integrations',
+    integrationName,
+  );
+  await fs.promises.mkdir(integrationPath, {
+    recursive: true,
+  });
+
+  const configCode: string = integrationConfigToCode(
+    integrationOutput.config,
+    integrationName,
+  );
+  await writeSourceToFile(integrationPath, 'config', configCode);
+
+  const workflowOutputs: WorkflowOutput[] = Object.values(
+    integrationOutput.workflows,
+  );
+
+  const workflowPath: string = path.join(integrationPath, 'workflows');
+
+  if (workflowOutputs.length) {
+    fs.promises.mkdir(workflowPath, {
+      recursive: true,
+    });
+  }
+
+  for (const workflowOutput of workflowOutputs) {
+    const workflowCode: string = workflowToCode(workflowOutput, {
+      ...projectDependencies,
+      integration: { name: integrationName },
+    });
+    await writeSourceToFile(workflowPath, workflowOutput.name, workflowCode);
+  }
+};
+
+/**
+ * generate all source files for project
+ * @param projectBuild
+ * @param projectRoot
+ */
+export const generateProjectFiles = async (
+  projectBuild: BuildOutput,
+  projectRoot: string,
+) => {
+  await fs.promises.mkdir(projectRoot, { recursive: true });
+
+  const events: IEvent[] = Object.values(projectBuild.events);
+
+  const eventPath: string = path.join(projectRoot, 'events');
+
+  if (events.length) {
+    await fs.promises.mkdir(eventPath, {
+      recursive: true,
+    });
+  }
+
+  for (const event of events) {
+    const eventSourceCode: string = eventToCode(event);
+    await writeSourceToFile(eventPath, event.name, eventSourceCode);
+  }
+
+  const integrationOutputs: Array<[string, IntegrationOutput]> = Object.entries(
+    projectBuild.integrations,
+  );
+
+  for (const [integrationName, integrationOutput] of integrationOutputs) {
+    await generateIntegrationFiles(
+      integrationName,
+      integrationOutput,
+      { events: projectBuild.events },
+      projectRoot,
+    );
+  }
+};

package/src/codegen/codegens/condition.codegen.ts

@@ -0,0 +1,49 @@
+import {
+  Condition,
+  Operator,
+  OperatorCondition,
+} from '@useparagon/core/resolvers';
+
+import { convertSourceToCode } from './source.codegen';
+
+/**
+ * convert condition to code
+ * @param condition
+ * @returns
+ */
+export const conditionToCode = (
+  operatorCondition: OperatorCondition,
+  stepIdToVariableMap: Record<string, string>,
+): string => {
+  let code: string = '';
+
+  const condition: Condition = operatorCondition.condition;
+
+  switch (condition.operator) {
+    case Operator.BooleanTrue: {
+      const variable: string = convertSourceToCode(
+        condition.variable,
+        stepIdToVariableMap,
+      );
+      code = `Operators.BooleanTrue(${variable})`;
+      break;
+    }
+
+    case Operator.StringContains: {
+      const variable: string = convertSourceToCode(
+        condition.variable,
+        stepIdToVariableMap,
+      );
+      const argument: string = convertSourceToCode(
+        condition.argument,
+        stepIdToVariableMap,
+      );
+      code = `Operators.StringContains(${variable},${argument})`;
+      break;
+    }
+    default:
+      code = 'undefined';
+      break;
+  }
+  return code;
+};

package/src/codegen/codegens/event.codegen.ts

@@ -0,0 +1,39 @@
+import { IEvent } from '@useparagon/core/event';
+
+import { stringifyObject } from '../../helpers/json';
+
+/**
+ * get source code for event
+ * @param event
+ * @returns
+ */
+export const eventToCode = (event: IEvent): string => {
+  const sourceCode: string = `
+ import { IEvent } from '@useparagon/core/event';
+
+ export type EventSchema = {
+
+ };
+ 
+ const event: IEvent<EventSchema> = {
+   /**
+    * This property is maintained by Paragon. Do not edit this property.
+    */
+   id: '${event.id}',
+
+   /**
+    *  name of event
+    */
+   name : '${event.name}',
+
+   /**
+    * schema of event payload
+    */
+   schema:${stringifyObject(event.schema)}
+ }
+
+ export default event;
+ `;
+
+  return sourceCode;
+};

package/src/codegen/codegens/integration.codegen.ts

@@ -0,0 +1,23 @@
+import { IntegrationOutput } from '../../compilers/compiler.types';
+import { stringifyObject } from '../../helpers/json';
+
+/**
+ * convert integration config to source code
+ * @returns
+ */
+export const integrationConfigToCode = (
+  config: IntegrationOutput['config'],
+  integrationName: string,
+): string => {
+  const sourceCode: string = `
+    import { IIntegrationConfig } from '@useparagon/core';
+
+    /**
+     * configuration for a ${integrationName}
+     */
+    const config: IIntegrationConfig = ${stringifyObject(config || {})}
+
+    export default config;`;
+
+  return sourceCode;
+};