@pgflow/dsl 0.0.5 → 0.0.6

package/src/example-flow.ts

@@ -1,67 +0,0 @@
-import { Flow } from './dsl.ts';
-
-// Provide a type for the input of the Flow
-type Input = {
-  url: string;
-};
-
-export const AnalyzeWebsite = new Flow<Input>({
-  slug: 'analyze_website',
-  maxAttempts: 3,
-  baseDelay: 5,
-  timeout: 10,
-})
-  .step(
-    { slug: 'website' },
-    async (input) => await scrapeWebsite(input.run.url)
-  )
-  .step(
-    { slug: 'sentiment', dependsOn: ['website'], timeout: 30, maxAttempts: 5 },
-    async (input) => await analyzeSentiment(input.website.content)
-  )
-  .step(
-    { slug: 'summary', dependsOn: ['website'] },
-    async (input) => await summarizeWithAI(input.website.content)
-  )
-  .step(
-    { slug: 'saveToDb', dependsOn: ['sentiment', 'summary'] },
-    async (input) => {
-      const results = await saveToDb({
-        websiteUrl: input.run.url,
-        sentiment: input.sentiment.score,
-        summary: input.summary.aiSummary,
-      });
-      return results.status;
-    }
-  );
-
-/***********************************************************************
- ****** functions *******************************************************
- ***********************************************************************/
-
-async function scrapeWebsite(url: string) {
-  return {
-    content: `Lorem ipsum ${url.length}`,
-  };
-}
-
-const analyzeSentiment = async (_content: string) => {
-  return {
-    score: Math.random(),
-  };
-};
-const summarizeWithAI = async (content: string) => {
-  return {
-    aiSummary: `Lorem ipsum ${content.length}`,
-  };
-};
-
-const saveToDb = async (_input: {
-  websiteUrl: string;
-  sentiment: number;
-  summary: string;
-}) => {
-  return {
-    status: 'success',
-  };
-};

package/src/index.ts

@@ -1 +0,0 @@
-export * from './dsl.ts';

package/src/utils.ts

@@ -1,84 +0,0 @@
-/**
- * Validates a slug string according to the following rules:
- * - Cannot start with a number
- * - Cannot start with an underscore
- * - Cannot contain spaces
- * - Cannot contain special characters like /, :, ?, #
- * - Cannot be longer than 128 characters
- *
- * @param slug The slug string to validate
- * @throws Error if the slug is invalid
- */
-export function validateSlug(slug: string): void {
-  if (slug.length > 128) {
-    throw new Error(`Slug cannot be longer than 128 characters`);
-  }
-
-  if (/^\d/.test(slug)) {
-    throw new Error(`Slug cannot start with a number`);
-  }
-
-  if (/^_/.test(slug)) {
-    throw new Error(`Slug cannot start with an underscore`);
-  }
-
-  if (/\s/.test(slug)) {
-    throw new Error(`Slug cannot contain spaces`);
-  }
-
-  if (/[/:#\-?]/.test(slug)) {
-    throw new Error(
-      `Slug cannot contain special characters like /, :, ?, #, -`
-    );
-  }
-}
-
-/**
- * Options for validating runtime options
- */
-export interface ValidateRuntimeOptionsOpts {
-  optional?: boolean;
-}
-
-/**
- * Validates runtime options according to the following rules:
- * - maxAttempts should be >= 1
- * - baseDelay should be >= 1
- * - timeout should be >= 3
- *
- * @param options The runtime options to validate
- * @param opts Configuration options for validation
- * @param opts.optional If true, allows options to be null or undefined
- * @throws Error if any runtime option is invalid
- */
-export function validateRuntimeOptions(
-  options: { maxAttempts?: number; baseDelay?: number; timeout?: number },
-  opts: ValidateRuntimeOptionsOpts = { optional: false }
-): void {
-  const { maxAttempts, baseDelay, timeout } = options;
-
-  // If optional is true, skip validation for undefined/null values
-  if (maxAttempts !== undefined && maxAttempts !== null) {
-    if (maxAttempts < 1) {
-      throw new Error('maxAttempts must be greater than or equal to 1');
-    }
-  } else if (!opts.optional) {
-    throw new Error('maxAttempts is required');
-  }
-
-  if (baseDelay !== undefined && baseDelay !== null) {
-    if (baseDelay < 1) {
-      throw new Error('baseDelay must be greater than or equal to 1');
-    }
-  } else if (!opts.optional) {
-    throw new Error('baseDelay is required');
-  }
-
-  if (timeout !== undefined && timeout !== null) {
-    if (timeout < 3) {
-      throw new Error('timeout must be greater than or equal to 3');
-    }
-  } else if (!opts.optional) {
-    throw new Error('timeout is required');
-  }
-}

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ]
-}

package/tsconfig.lib.json

@@ -1,26 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "tsBuildInfoFile": "dist/tsconfig.lib.tsbuildinfo",
-    "emitDeclarationOnly": false,
-    "types": ["node", "vite/client"],
-    "allowImportingTsExtensions": true
-  },
-  "include": ["src/**/*.ts"],
-  "references": [],
-  "exclude": [
-    "vite.config.ts",
-    "vite.config.mts",
-    "vitest.config.ts",
-    "vitest.config.mts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.test.tsx",
-    "src/**/*.spec.tsx",
-    "src/**/*.test.js",
-    "src/**/*.spec.js",
-    "src/**/*.test.jsx",
-    "src/**/*.spec.jsx"
-  ]
-}

package/tsconfig.spec.json

@@ -1,35 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "./out-tsc/vitest",
-    "types": [
-      "vitest/globals",
-      "vitest/importMeta",
-      "vite/client",
-      "node",
-      "vitest"
-    ],
-    "allowImportingTsExtensions": true
-  },
-  "include": [
-    "vite.config.ts",
-    "vite.config.mts",
-    "vitest.config.ts",
-    "vitest.config.mts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.test.tsx",
-    "src/**/*.spec.tsx",
-    "src/**/*.test.js",
-    "src/**/*.spec.js",
-    "src/**/*.test.jsx",
-    "src/**/*.spec.jsx",
-    "src/**/*.d.ts",
-    "__tests__/**/*.ts"
-  ],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    }
-  ]
-}

package/typecheck.log

@@ -1,120 +0,0 @@
-
-> nx run dsl:typecheck
-
-> tsc --build --emitDeclarationOnly --pretty --verbose
-
-[9:57:14 PM] Projects in this build: 
-    * tsconfig.lib.json
-    * tsconfig.spec.json
-    * tsconfig.json
-
-[9:57:14 PM] Project 'tsconfig.lib.json' is up to date because newest input 'src/dsl.ts' is older than output 'dist/tsconfig.lib.tsbuildinfo'
-
-[9:57:14 PM] Project 'tsconfig.spec.json' is out of date because buildinfo file 'out-tsc/vitest/tsconfig.spec.tsbuildinfo' indicates that program needs to report errors.
-
-[9:57:14 PM] Building project '/home/jumski/Code/pgflow-dev/pgflow/pkgs/dsl/tsconfig.spec.json'...
-
-__tests__/types/dsl-types.test-d.ts:112:37 - error TS2344: Type 'Flow<{ input: string; }, EmptySteps & { step1: { value: number; text: string; }; } & { step2: { flag: true; }; } & { step3: "plain string"; }, EmptyDeps & { step1: never[]; } & { ...; } & { ...; }>' does not satisfy the constraint 'AnyFlow'.
-  The types returned by 'getStepDefinition(...)' are incompatible between these types.
-    Type 'StepDefinition<{ [x: string]: any; run: { input: string; }; }, any>' is not assignable to type 'StepDefinition<{ [x: string]: Json; run: Json; }, Json>'.
-      Type '{ [x: string]: Json; run: Json; }' is not assignable to type '{ [x: string]: any; run: { input: string; }; }'.
-        Types of property 'run' are incompatible.
-          Type 'Json' is not assignable to type '{ input: string; }'.
-            Type 'null' is not assignable to type '{ input: string; }'.
-
-112       type Step1Output = StepOutput<typeof flow, 'step1'>;
-                                        ~~~~~~~~~~~
-
-__tests__/types/dsl-types.test-d.ts:113:49 - error TS2344: Type '{ value: number; text: string; }' does not satisfy the constraint '"Expected: ..., Actual: never"'.
-
-113       expectTypeOf<Step1Output>().toMatchTypeOf<{
-                                                    ~
-114         value: number;
-    ~~~~~~~~~~~~~~~~~~~~~~
-115         text: string;
-    ~~~~~~~~~~~~~~~~~~~~~
-116       }>();
-    ~~~~~~~
-
-__tests__/types/dsl-types.test-d.ts:118:37 - error TS2344: Type 'Flow<{ input: string; }, EmptySteps & { step1: { value: number; text: string; }; } & { step2: { flag: true; }; } & { step3: "plain string"; }, EmptyDeps & { step1: never[]; } & { ...; } & { ...; }>' does not satisfy the constraint 'AnyFlow'.
-  The types returned by 'getStepDefinition(...)' are incompatible between these types.
-    Type 'StepDefinition<{ [x: string]: any; run: { input: string; }; }, any>' is not assignable to type 'StepDefinition<{ [x: string]: Json; run: Json; }, Json>'.
-      Type '{ [x: string]: Json; run: Json; }' is not assignable to type '{ [x: string]: any; run: { input: string; }; }'.
-        Types of property 'run' are incompatible.
-          Type 'Json' is not assignable to type '{ input: string; }'.
-            Type 'null' is not assignable to type '{ input: string; }'.
-
-118       type Step2Output = StepOutput<typeof flow, 'step2'>;
-                                        ~~~~~~~~~~~
-
-__tests__/types/dsl-types.test-d.ts:119:49 - error TS2344: Type '{ flag: boolean; }' does not satisfy the constraint '"Expected: ..., Actual: never"'.
-
-119       expectTypeOf<Step2Output>().toMatchTypeOf<{ flag: boolean }>();
-                                                    ~~~~~~~~~~~~~~~~~
-
-__tests__/types/dsl-types.test-d.ts:121:37 - error TS2344: Type 'Flow<{ input: string; }, EmptySteps & { step1: { value: number; text: string; }; } & { step2: { flag: true; }; } & { step3: "plain string"; }, EmptyDeps & { step1: never[]; } & { ...; } & { ...; }>' does not satisfy the constraint 'AnyFlow'.
-  The types returned by 'getStepDefinition(...)' are incompatible between these types.
-    Type 'StepDefinition<{ [x: string]: any; run: { input: string; }; }, any>' is not assignable to type 'StepDefinition<{ [x: string]: Json; run: Json; }, Json>'.
-      Type '{ [x: string]: Json; run: Json; }' is not assignable to type '{ [x: string]: any; run: { input: string; }; }'.
-        Types of property 'run' are incompatible.
-          Type 'Json' is not assignable to type '{ input: string; }'.
-            Type 'null' is not assignable to type '{ input: string; }'.
-
-121       type Step3Output = StepOutput<typeof flow, 'step3'>;
-                                        ~~~~~~~~~~~
-
-__tests__/types/dsl-types.test-d.ts:122:49 - error TS2344: Type 'string' does not satisfy the constraint '"Expected: string, Actual: never"'.
-
-122       expectTypeOf<Step3Output>().toMatchTypeOf<string>();
-                                                    ~~~~~~
-
-__tests__/types/dsl-types.test-d.ts:124:43 - error TS2344: Type 'Flow<{ input: string; }, EmptySteps & { step1: { value: number; text: string; }; } & { step2: { flag: true; }; } & { step3: "plain string"; }, EmptyDeps & { step1: never[]; } & { ...; } & { ...; }>' does not satisfy the constraint 'AnyFlow'.
-  The types returned by 'getStepDefinition(...)' are incompatible between these types.
-    Type 'StepDefinition<{ [x: string]: any; run: { input: string; }; }, any>' is not assignable to type 'StepDefinition<{ [x: string]: Json; run: Json; }, Json>'.
-      Type '{ [x: string]: Json; run: Json; }' is not assignable to type '{ [x: string]: any; run: { input: string; }; }'.
-        Types of property 'run' are incompatible.
-          Type 'Json' is not assignable to type '{ input: string; }'.
-            Type 'null' is not assignable to type '{ input: string; }'.
-
-124       type NonExistentOutput = StepOutput<typeof flow, 'nonExistentStep'>;
-                                              ~~~~~~~~~~~
-
-__tests__/types/dsl-types.test-d.ts:144:43 - error TS2344: Type 'Flow<{ id: number; }, EmptySteps & { complexStep: { data: { items: { id: number; name: string; }[]; metadata: { count: number; lastUpdated: string; }; }; }; }, EmptyDeps & { complexStep: never[]; }>' does not satisfy the constraint 'AnyFlow'.
-  The types returned by 'getStepDefinition(...)' are incompatible between these types.
-    Type 'StepDefinition<{ [x: string]: any; run: { id: number; }; }, any>' is not assignable to type 'StepDefinition<{ [x: string]: Json; run: Json; }, Json>'.
-      Type '{ [x: string]: Json; run: Json; }' is not assignable to type '{ [x: string]: any; run: { id: number; }; }'.
-        Types of property 'run' are incompatible.
-          Type 'Json' is not assignable to type '{ id: number; }'.
-            Type 'null' is not assignable to type '{ id: number; }'.
-
-144       type ComplexStepOutput = StepOutput<typeof complexFlow, 'complexStep'>;
-                                              ~~~~~~~~~~~~~~~~~~
-
-__tests__/types/dsl-types.test-d.ts:145:55 - error TS2344: Type '{ data: { items: { id: number; name: string; }[]; metadata: { count: number; lastUpdated: string; }; }; }' does not satisfy the constraint '"Expected: ..., Actual: never"'.
-
-145       expectTypeOf<ComplexStepOutput>().toMatchTypeOf<{
-                                                          ~
-146         data: {
-    ~~~~~~~~~~~~~~~
-... 
-152         };
-    ~~~~~~~~~~
-153       }>();
-    ~~~~~~~
-
-
-Found 9 errors.
-
-
-
-
- NX   Running target typecheck for project dsl failed
-
-Failed tasks:
-
-- dsl:typecheck
-
-Hint: run the command with --verbose for more details.
-
-View structured, searchable error logs at https://nx.app/runs/7SrNf6iuVJ
-

package/vite.config.ts

@@ -1,57 +0,0 @@
-/// <reference types='vitest' />
-import { defineConfig } from 'vite';
-import dts from 'vite-plugin-dts';
-import * as path from 'path';
-import tsconfigPaths from 'vite-tsconfig-paths';
-
-export default defineConfig({
-  root: __dirname,
-  cacheDir: '../../node_modules/.vite/pkgs/dsl',
-  plugins: [
-    tsconfigPaths(),
-    dts({
-      entryRoot: 'src',
-      tsconfigPath: path.join(__dirname, 'tsconfig.lib.json'),
-    }),
-  ],
-  // Uncomment this if you are using workers.
-  // worker: {
-  //  plugins: [ nxViteTsPaths() ],
-  // },
-  // Configuration for building your library.
-  // See: https://vitejs.dev/guide/build.html#library-mode
-  build: {
-    outDir: './dist',
-    emptyOutDir: true,
-    reportCompressedSize: true,
-    commonjsOptions: {
-      transformMixedEsModules: true,
-    },
-    lib: {
-      // Could also be a dictionary or array of multiple entry points.
-      entry: 'src/index.ts',
-      name: '@pgflow/dsl',
-      fileName: 'index',
-      // Change this to the formats you want to support.
-      // Don't forget to update your package.json as well.
-      formats: ['es'],
-    },
-    rollupOptions: {
-      // External packages that should not be bundled into your library.
-      external: [],
-    },
-  },
-  test: {
-    watch: false,
-    globals: true,
-    environment: 'node',
-    include: [
-      '{src,__tests__}/**/*.{test,spec,test-d,spec-d}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}',
-    ],
-    reporters: ['default'],
-    coverage: {
-      reportsDirectory: './test-output/vitest/coverage',
-      provider: 'v8',
-    },
-  },
-});