Merge pull request #430 from ajthinking/string-list-cleanup

ajthinking · web-flow · commit 8b913628554a · 2025-06-02T17:14:25.000+02:00
Deprecate createDefaultStringable
diff --git a/packages/core/src/InputDevice.test.ts b/packages/core/src/InputDevice.test.ts
@@ -1,7 +1,7 @@
 import { Diagram } from './Diagram'
 import { ExecutionMemory } from './ExecutionMemory'
 import { InputDevice } from './InputDevice'
-import { createDefaultStringable } from './Param'
+import { str } from './Param'
 import { UnfoldedDiagramFactory } from './UnfoldedDiagramFactory'
 import { Node } from './types/Node'
 
@@ -222,7 +222,7 @@ describe('params', () => {
       name: 'node-type',
       inputs: [{ id: 'target-input-id', name: 'input', schema: {} }],
       outputs: [],
-      params: [createDefaultStringable({
+      params: [str({
         name: 'greeting',
         label: 'Greeting',
         help: 'The greeting to use',
diff --git a/packages/core/src/Param/Param.ts b/packages/core/src/Param/Param.ts
@@ -54,61 +54,6 @@ export type Param =
 
 export type ParamValue = Param['input']
 
-type StringableConfigType = Omit<StringableParam, 'input' | 'type'> & {
-  value: StringableInputValue['rawValue']
-}
-
-export const strList = ({
-  name,
-  label,
-  help,
-  value,
-}: {
-  name: string,
-  label?: string,
-  help?: string,
-  value?: unknown,
-}): StringListParam => {
-  return {
-    name,
-    type: 'StringListParam',
-    label: label ?? name,
-    help: help ?? '',
-    input: {
-      rawValue: value ?? undefined,
-    },
-  }
-}
-
-export const createDefaultStringable = ({
-  name,
-  label,
-  help,
-  multiline,
-  canInterpolate,
-  interpolate,
-  evaluations,
-  casts,
-  interpolationsFromPort,
-  value,
-}:StringableConfigType): StringableParam => {
-  return {
-    name,
-    type: 'StringableParam',
-    label,
-    help,
-    multiline,
-    canInterpolate,
-    interpolate,
-    evaluations,
-    casts,
-    interpolationsFromPort,
-    input: {
-      rawValue: value ?? '',
-    },
-  }
-}
-
 export const str = ({
   name,
   label,
diff --git a/packages/core/src/computers/Comment.ts b/packages/core/src/computers/Comment.ts
@@ -1,5 +1,5 @@
 import { multiline } from '../utils/multiline';
-import { createDefaultStringable } from '../Param';
+import { str } from '../Param';
 import { Computer } from '../types/Computer';
 
 export const Comment: Computer = {
@@ -8,15 +8,14 @@ export const Comment: Computer = {
   inputs: [],
   outputs: [],
   params: [
-    createDefaultStringable( {
+    str( {
       name: 'content',
       label: 'Content',
       help: 'Markdown content',
       multiline: true,
       canInterpolate: false,
       interpolate: false,
       evaluations: [],
-      casts: [],
       value: multiline`
         ### Comment
         paragraph
diff --git a/packages/core/src/computers/ConsoleLog.ts b/packages/core/src/computers/ConsoleLog.ts
@@ -2,7 +2,7 @@ import { numberCast } from '../Param/casts/numberCast';
 import { stringCast } from '../Param/casts/stringCast';
 import { jsFunctionEvaluation } from '../Param/evaluations/jsFunctionEvaluation';
 import { jsonEvaluation } from '../Param/evaluations/jsonEvaluation';
-import { createDefaultStringable } from '../Param';
+import { str } from '../Param';
 import { Computer } from '../types/Computer';
 
 export const ConsoleLog: Computer = {
@@ -16,7 +16,7 @@ export const ConsoleLog: Computer = {
   ],
   outputs: [],
   params: [
-    createDefaultStringable( {
+    str( {
       name: 'message',
       label: 'message',
       help: 'What to log. Leave blank to log the whole item.',
@@ -27,10 +27,6 @@ export const ConsoleLog: Computer = {
         jsFunctionEvaluation,
         jsonEvaluation,
       ],
-      casts: [
-        numberCast,
-        stringCast,
-      ],
       value: '',
     }),
   ],
diff --git a/packages/core/src/computers/Input.ts b/packages/core/src/computers/Input.ts
@@ -1,4 +1,4 @@
-import { createDefaultStringable, str } from '../Param';
+import { str } from '../Param';
 import { Computer } from '../types/Computer';
 
 export const Input: Computer = {
@@ -13,7 +13,7 @@ export const Input: Computer = {
     schema: {},
   }],
   params: [
-    createDefaultStringable({
+    str({
       name: 'port_name',
       label: 'Port Name',
       value: 'input',
diff --git a/packages/core/src/computers/Output.ts b/packages/core/src/computers/Output.ts
@@ -1,4 +1,4 @@
-import { createDefaultStringable, str } from '../Param';
+import { str } from '../Param';
 import { Computer } from '../types/Computer';
 import { BatchLimit } from '../utils/batchLimit';
 
@@ -14,7 +14,7 @@ export const Output: Computer = {
     schema: {},
   }],
   params: [
-    createDefaultStringable({
+    str({
       name: 'port_name',
       label: 'Port Name',
       value: 'output',
diff --git a/packages/core/src/computers/Sleep.ts b/packages/core/src/computers/Sleep.ts
@@ -1,6 +1,5 @@
 import { sleep } from '../utils/sleep';
-import { numberCast } from '../Param/casts/numberCast';
-import { createDefaultStringable } from '../Param';
+import { num } from '../Param';
 import { Computer } from '../types/Computer';
 
 export const Sleep: Computer = {
@@ -15,17 +14,14 @@ export const Sleep: Computer = {
     schema: {},
   }],
   params: [
-    createDefaultStringable({
+    num({
       name: 'duration',
       label: 'Duration',
       help: 'How many ms to sleep?',
       multiline: false,
       canInterpolate: true,
       interpolate: true,
-      casts: [
-        { ...numberCast, selected: true },
-      ],
-      value: String(100),
+      value: 100,
     }),
   ],
 
diff --git a/packages/core/src/computers/Table.ts b/packages/core/src/computers/Table.ts
@@ -1,4 +1,4 @@
-import { num, str, strList } from '../Param';
+import { str } from '../Param';
 import { Computer } from '../types/Computer';
 import { BatchLimit } from '../utils/batchLimit';
 
diff --git a/packages/core/src/computers/Throw.ts b/packages/core/src/computers/Throw.ts
@@ -3,7 +3,7 @@ import { numberCast } from '../Param/casts/numberCast';
 import { stringCast } from '../Param/casts/stringCast';
 import { jsFunctionEvaluation } from '../Param/evaluations/jsFunctionEvaluation';
 import { jsonEvaluation } from '../Param/evaluations/jsonEvaluation';
-import { createDefaultStringable } from '../Param';
+import { str } from '../Param';
 import { Computer } from '../types/Computer';
 
 export const Throw: Computer = {
@@ -15,7 +15,7 @@ export const Throw: Computer = {
   }],
   outputs: [],
   params: [
-    createDefaultStringable({
+    str({
       name: 'message',
       label: 'message',
       help: 'What to throw',
@@ -26,10 +26,6 @@ export const Throw: Computer = {
         jsFunctionEvaluation,
         jsonEvaluation,
       ],
-      casts: [
-        numberCast,
-        stringCast,
-      ],
       value: 'Some error',
     }),
   ],
diff --git a/packages/nodejs/src/computers/ListFiles/ListFiles.ts b/packages/nodejs/src/computers/ListFiles/ListFiles.ts
@@ -1,4 +1,4 @@
-import { Computer, createDefaultStringable } from '@data-story/core';
+import { Computer, str } from '@data-story/core';
 import { promises as fs } from 'fs'
 import * as nodePath from 'path'
 
@@ -19,15 +19,14 @@ export const ListFiles: Computer = {
     },
   }],
   params: [
-    createDefaultStringable({
+    str({
       name: 'path',
       label: 'Path',
       help: 'Dir to list',
       multiline: true,
       canInterpolate: false,
       interpolate: false,
       evaluations: [],
-      casts: [],
       value: '/',
     }),
   ],
diff --git a/packages/nodejs/src/computers/ReadFiles/ReadFiles.ts b/packages/nodejs/src/computers/ReadFiles/ReadFiles.ts
@@ -1,6 +1,6 @@
 import * as glob from 'glob';
 import { promises as fs } from 'fs';
-import { Computer, createDefaultStringable } from '@data-story/core';
+import { Computer, str } from '@data-story/core';
 
 export const ReadFiles: Computer = {
   name: 'ReadFiles',
@@ -18,29 +18,26 @@ export const ReadFiles: Computer = {
     },
   }],
   params: [
-    createDefaultStringable({
+    str({
       name: 'include',
       label: 'Include',
       help: 'Glob pattern to include',
       multiline: true,
       canInterpolate: true,
       interpolate: true,
       evaluations: [],
-      casts: [],
       value: '${path}/**/*.ts',
     }),
-    createDefaultStringable(    {
+    str({
       name: 'ignore',
       label: 'Ignore',
       help: 'Glob pattern to ignore',
       multiline: true,
       canInterpolate: true,
       interpolate: true,
       evaluations: [],
-      casts: [],
       value: '**/node_modules/**',
-    },
-    ),
+    }),
   ],
 
   async *run({ input, output }) {
diff --git a/packages/ui/src/components/DataStory/modals/runModal/DefineMode.tsx b/packages/ui/src/components/DataStory/modals/runModal/DefineMode.tsx
@@ -1,15 +1,14 @@
-import { createDefaultStringable } from '@data-story/core';
+import { str } from '@data-story/core';
 
 const DefineMode = ({ params, setParams, setDefineMode }) => {
-  const sampleParam = createDefaultStringable({
+  const sampleParam = str({
     name: 'sampleParam',
     label: 'sampleParam',
     help: '',
     multiline: false,
     canInterpolate: true,
     interpolate: true,
     evaluations: [],
-    casts: [],
     value: 'default value',
   })
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { num, str, strList } from '../Param';`
	`1`	`+import { str } from '../Param';`
`2`	`2`	`import { Computer } from '../types/Computer';`
`3`	`3`	`import { BatchLimit } from '../utils/batchLimit';`
`4`	`4`