@datashaper/schema
Advanced tools
Comparing version 10.0.2 to 11.0.0
@@ -5,2 +5,3 @@ /*! | ||
*/ | ||
import type { DataFormat } from "../data.js"; | ||
/** | ||
@@ -12,2 +13,10 @@ * Configuration values for interpreting data types when parsing a delimited file. | ||
/** | ||
* The data format | ||
*/ | ||
dataFormat?: DataFormat; | ||
/** | ||
* The character to use for delimiting arrays. | ||
*/ | ||
arrayDelimiter?: string; | ||
/** | ||
* Default: case-insenstive word "true". | ||
@@ -14,0 +23,0 @@ */ |
/*! | ||
* Copyright (c) Microsoft. All rights reserved. | ||
* Licensed under the MIT license. See LICENSE file in the project. | ||
*/ /** | ||
*/ import { DataFormat } from '../data.js'; | ||
/** | ||
* This is a collection of default string values for inferring strict types from strings. | ||
@@ -9,2 +10,4 @@ * They replicate the defaults from pandas. | ||
*/ export const TypeHintsDefaults = { | ||
dataFormat: DataFormat.CSV, | ||
arrayDelimiter: ",", | ||
trueValues: [ | ||
@@ -11,0 +14,0 @@ 'true' |
/*! | ||
* Copyright (c) Microsoft. All rights reserved. | ||
* Licensed under the MIT license. See LICENSE file in the project. | ||
*/ /** | ||
* Configuration values for interpreting data types when parsing a delimited file. | ||
* By default, all values are read as strings - applying these type hints can derive primitive types from the strings. | ||
*/ export { }; |
@@ -5,12 +5,6 @@ /*! | ||
*/ | ||
export type PortBinding = string | NamedPortBinding; | ||
/** | ||
* An explicit step input binding | ||
* The Id of the step to which the input is bound | ||
*/ | ||
export interface NamedPortBinding { | ||
/** | ||
* The id of the input node to bind to | ||
*/ | ||
node: string; | ||
} | ||
export type WorkflowStepId = string; | ||
/** | ||
@@ -27,3 +21,3 @@ * Single-input, single-output step I/O | ||
input?: string | { | ||
source: PortBinding; | ||
source: WorkflowStepId; | ||
}; | ||
@@ -42,7 +36,7 @@ } | ||
*/ | ||
source: PortBinding; | ||
source: WorkflowStepId; | ||
/** | ||
* The secondary input, which must be specified | ||
*/ | ||
other: PortBinding; | ||
other: WorkflowStepId; | ||
}; | ||
@@ -62,8 +56,22 @@ } | ||
*/ | ||
source: PortBinding; | ||
source: WorkflowStepId; | ||
/** | ||
* The variadic secondary inputs | ||
*/ | ||
others?: PortBinding[]; | ||
others?: WorkflowStepId[]; | ||
}; | ||
} | ||
export interface UnknownInput { | ||
input?: string | { | ||
/** | ||
* Possible main input | ||
**/ | ||
source?: WorkflowStepId; | ||
/** | ||
* Possible variadic input | ||
*/ | ||
others?: WorkflowStepId[]; | ||
/** Possible other input */ | ||
[key: string]: WorkflowStepId | WorkflowStepId[] | undefined; | ||
}; | ||
} |
/*! | ||
* Copyright (c) Microsoft. All rights reserved. | ||
* Licensed under the MIT license. See LICENSE file in the project. | ||
*/ /** | ||
* The Id of the step to which the input is bound | ||
*/ export { }; |
@@ -5,3 +5,3 @@ /*! | ||
*/ | ||
import type { BasicInput, DualInput, VariadicInput } from './bindings.js'; | ||
import type { BasicInput, DualInput, UnknownInput, VariadicInput } from './bindings.js'; | ||
import type { AggregateArgs, BinArgs, BinarizeArgs, BooleanArgs, ConvertArgs, DedupeArgs, DeriveArgs, EncodeDecodeArgs, EraseArgs, FillArgs, FilterArgs, FoldArgs, GroupbyArgs, ImputeArgs, JoinArgs, LookupArgs, MergeArgs, OnehotArgs, OrderbyArgs, PivotArgs, RecodeArgs, RenameArgs, RollupArgs, SampleArgs, SelectArgs, SpreadArgs, UnfoldArgs, UnhotArgs, UnrollArgs, Verb, WindowArgs } from './verbs.js'; | ||
@@ -125,2 +125,9 @@ /** | ||
args?: WindowArgs; | ||
} & BasicInput)); | ||
} & BasicInput) | ||
/** | ||
* Custom step - we may not know the verb, args, or binding pattern | ||
*/ | ||
| ({ | ||
verb: string; | ||
args?: unknown; | ||
} & UnknownInput)); |
@@ -424,2 +424,6 @@ /*! | ||
proportion?: number; | ||
/** | ||
* The randomization seed to use for sampling to ensure stable sampling. | ||
*/ | ||
seed?: number; | ||
} | ||
@@ -426,0 +430,0 @@ export type SelectArgs = InputColumnListArgs; |
@@ -15,4 +15,4 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
input?: string | { | ||
source: PortBinding; | ||
source: WorkflowStepId; | ||
}; | ||
``` |
@@ -19,3 +19,3 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
| --- | --- | --- | --- | | ||
| [input?](./schema.basicinput.input.md) | | string \| { source: [PortBinding](./schema.portbinding.md)<!-- -->; } | <p><i>(Optional)</i> Standard step input; single source with default name "source".</p><p>If undefined, the default output of the previous step will be used (if available). If no previous step is available, this will remain undefined</p> | | ||
| [input?](./schema.basicinput.input.md) | | string \| { source: [WorkflowStepId](./schema.workflowstepid.md)<!-- -->; } | <p><i>(Optional)</i> Standard step input; single source with default name "source".</p><p>If undefined, the default output of the previous step will be used (if available). If no previous step is available, this will remain undefined</p> | | ||
@@ -13,5 +13,5 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
input: { | ||
source: PortBinding; | ||
other: PortBinding; | ||
source: WorkflowStepId; | ||
other: WorkflowStepId; | ||
}; | ||
``` |
@@ -20,3 +20,3 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
| --- | --- | --- | --- | | ||
| [input](./schema.dualinput.input.md) | | { source: [PortBinding](./schema.portbinding.md)<!-- -->; other: [PortBinding](./schema.portbinding.md)<!-- -->; } | The inputs that must be bound; "source" & "other". | | ||
| [input](./schema.dualinput.input.md) | | { source: [WorkflowStepId](./schema.workflowstepid.md)<!-- -->; other: [WorkflowStepId](./schema.workflowstepid.md)<!-- -->; } | The inputs that must be bound; "source" & "other". | | ||
@@ -87,3 +87,2 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
| [Named](./schema.named.md) | Base interface for sharing properties of named resources/objects. | | ||
| [NamedPortBinding](./schema.namedportbinding.md) | An explicit step input binding | | ||
| [OnehotArgs](./schema.onehotargs.md) | | | ||
@@ -105,2 +104,3 @@ | [OrderbyArgs](./schema.orderbyargs.md) | | | ||
| [UnhotArgs](./schema.unhotargs.md) | | | ||
| [UnknownInput](./schema.unknowninput.md) | | | ||
| [ValidationResult](./schema.validationresult.md) | | | ||
@@ -131,3 +131,2 @@ | [VariadicInput](./schema.variadicinput.md) | Multi-input, single output step I/O | | ||
| [GroupbyArgs](./schema.groupbyargs.md) | | | ||
| [PortBinding](./schema.portbinding.md) | | | ||
| [Profile](./schema.profile.md) | Resources must have a profile, which is a key defining how it should be interpreted. Profiles are essentially shorthand for a schema URL. The core profiles for DataShaper are defined here, but any application can define one as a string. | | ||
@@ -142,2 +141,3 @@ | [Rel](./schema.rel.md) | A rel is a string that describes the relationship between a resource and its child. | | ||
| [Value](./schema.value.md) | A cell/property value of any type. | | ||
| [WorkflowStepId](./schema.workflowstepid.md) | The Id of the step to which the input is bound | | ||
@@ -18,3 +18,4 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
| [proportion?](./schema.sampleargs.proportion.md) | | number | <i>(Optional)</i> If table size is unknown ahead of time, specify a proportion of rows to sample. If size is specified, it will be used instead, otherwise computed from this proportion using the table.numRows() | | ||
| [seed?](./schema.sampleargs.seed.md) | | number | <i>(Optional)</i> The randomization seed to use for sampling to ensure stable sampling. | | ||
| [size?](./schema.sampleargs.size.md) | | number | <i>(Optional)</i> Number of rows to sample from the table. This takes precedence over proportion. | | ||
@@ -117,5 +117,12 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
args?: WindowArgs; | ||
} & BasicInput)); | ||
} & BasicInput) | ||
/** | ||
* Custom step - we may not know the verb, args, or binding pattern | ||
*/ | ||
| ({ | ||
verb: string; | ||
args?: unknown; | ||
} & UnknownInput)); | ||
``` | ||
<b>References:</b> [StepJsonCommon](./schema.stepjsoncommon.md)<!-- -->, [Verb.Aggregate](./schema.verb.md)<!-- -->, [AggregateArgs](./schema.aggregateargs.md)<!-- -->, [BasicInput](./schema.basicinput.md)<!-- -->, [Verb.Bin](./schema.verb.md)<!-- -->, [BinArgs](./schema.binargs.md)<!-- -->, [Verb.Binarize](./schema.verb.md)<!-- -->, [BinarizeArgs](./schema.binarizeargs.md)<!-- -->, [Verb.Boolean](./schema.verb.md)<!-- -->, [BooleanArgs](./schema.booleanargs.md)<!-- -->, [Verb.Concat](./schema.verb.md)<!-- -->, [VariadicInput](./schema.variadicinput.md)<!-- -->, [Verb.Convert](./schema.verb.md)<!-- -->, [ConvertArgs](./schema.convertargs.md)<!-- -->, [Verb.Dedupe](./schema.verb.md)<!-- -->, [DedupeArgs](./schema.dedupeargs.md)<!-- -->, [Verb.Derive](./schema.verb.md)<!-- -->, [DeriveArgs](./schema.deriveargs.md)<!-- -->, [Verb.Difference](./schema.verb.md)<!-- -->, [Verb.Decode](./schema.verb.md)<!-- -->, [EncodeDecodeArgs](./schema.encodedecodeargs.md)<!-- -->, [Verb.Encode](./schema.verb.md)<!-- -->, [Verb.Erase](./schema.verb.md)<!-- -->, [EraseArgs](./schema.eraseargs.md)<!-- -->, [Verb.Fill](./schema.verb.md)<!-- -->, [FillArgs](./schema.fillargs.md)<!-- -->, [Verb.Filter](./schema.verb.md)<!-- -->, [FilterArgs](./schema.filterargs.md)<!-- -->, [Verb.Fold](./schema.verb.md)<!-- -->, [FoldArgs](./schema.foldargs.md)<!-- -->, [Verb.Groupby](./schema.verb.md)<!-- -->, [GroupbyArgs](./schema.groupbyargs.md)<!-- -->, [Verb.Impute](./schema.verb.md)<!-- -->, [ImputeArgs](./schema.imputeargs.md)<!-- -->, [Verb.Intersect](./schema.verb.md)<!-- -->, [Verb.Join](./schema.verb.md)<!-- -->, [JoinArgs](./schema.joinargs.md)<!-- -->, [DualInput](./schema.dualinput.md)<!-- -->, [Verb.Lookup](./schema.verb.md)<!-- -->, [LookupArgs](./schema.lookupargs.md)<!-- -->, [Verb.Merge](./schema.verb.md)<!-- -->, [MergeArgs](./schema.mergeargs.md)<!-- -->, [Verb.Onehot](./schema.verb.md)<!-- -->, [OnehotArgs](./schema.onehotargs.md)<!-- -->, [Verb.Orderby](./schema.verb.md)<!-- -->, [OrderbyArgs](./schema.orderbyargs.md)<!-- -->, [Verb.Pivot](./schema.verb.md)<!-- -->, [PivotArgs](./schema.pivotargs.md)<!-- -->, [Verb.Recode](./schema.verb.md)<!-- -->, [RecodeArgs](./schema.recodeargs.md)<!-- -->, [Verb.Rename](./schema.verb.md)<!-- -->, [RenameArgs](./schema.renameargs.md)<!-- -->, [Verb.Rollup](./schema.verb.md)<!-- -->, [RollupArgs](./schema.rollupargs.md)<!-- -->, [Verb.Sample](./schema.verb.md)<!-- -->, [SampleArgs](./schema.sampleargs.md)<!-- -->, [Verb.Select](./schema.verb.md)<!-- -->, [SelectArgs](./schema.selectargs.md)<!-- -->, [Verb.Spread](./schema.verb.md)<!-- -->, [SpreadArgs](./schema.spreadargs.md)<!-- -->, [Verb.Unfold](./schema.verb.md)<!-- -->, [UnfoldArgs](./schema.unfoldargs.md)<!-- -->, [Verb.Ungroup](./schema.verb.md)<!-- -->, [Verb.Unhot](./schema.verb.md)<!-- -->, [UnhotArgs](./schema.unhotargs.md)<!-- -->, [Verb.Union](./schema.verb.md)<!-- -->, [Verb.Unorder](./schema.verb.md)<!-- -->, [Verb.Unroll](./schema.verb.md)<!-- -->, [UnrollArgs](./schema.unrollargs.md)<!-- -->, [Verb.Window](./schema.verb.md)<!-- -->, [WindowArgs](./schema.windowargs.md) | ||
<b>References:</b> [StepJsonCommon](./schema.stepjsoncommon.md)<!-- -->, [Verb.Aggregate](./schema.verb.md)<!-- -->, [AggregateArgs](./schema.aggregateargs.md)<!-- -->, [BasicInput](./schema.basicinput.md)<!-- -->, [Verb.Bin](./schema.verb.md)<!-- -->, [BinArgs](./schema.binargs.md)<!-- -->, [Verb.Binarize](./schema.verb.md)<!-- -->, [BinarizeArgs](./schema.binarizeargs.md)<!-- -->, [Verb.Boolean](./schema.verb.md)<!-- -->, [BooleanArgs](./schema.booleanargs.md)<!-- -->, [Verb.Concat](./schema.verb.md)<!-- -->, [VariadicInput](./schema.variadicinput.md)<!-- -->, [Verb.Convert](./schema.verb.md)<!-- -->, [ConvertArgs](./schema.convertargs.md)<!-- -->, [Verb.Dedupe](./schema.verb.md)<!-- -->, [DedupeArgs](./schema.dedupeargs.md)<!-- -->, [Verb.Derive](./schema.verb.md)<!-- -->, [DeriveArgs](./schema.deriveargs.md)<!-- -->, [Verb.Difference](./schema.verb.md)<!-- -->, [Verb.Decode](./schema.verb.md)<!-- -->, [EncodeDecodeArgs](./schema.encodedecodeargs.md)<!-- -->, [Verb.Encode](./schema.verb.md)<!-- -->, [Verb.Erase](./schema.verb.md)<!-- -->, [EraseArgs](./schema.eraseargs.md)<!-- -->, [Verb.Fill](./schema.verb.md)<!-- -->, [FillArgs](./schema.fillargs.md)<!-- -->, [Verb.Filter](./schema.verb.md)<!-- -->, [FilterArgs](./schema.filterargs.md)<!-- -->, [Verb.Fold](./schema.verb.md)<!-- -->, [FoldArgs](./schema.foldargs.md)<!-- -->, [Verb.Groupby](./schema.verb.md)<!-- -->, [GroupbyArgs](./schema.groupbyargs.md)<!-- -->, [Verb.Impute](./schema.verb.md)<!-- -->, [ImputeArgs](./schema.imputeargs.md)<!-- -->, [Verb.Intersect](./schema.verb.md)<!-- -->, [Verb.Join](./schema.verb.md)<!-- -->, [JoinArgs](./schema.joinargs.md)<!-- -->, [DualInput](./schema.dualinput.md)<!-- -->, [Verb.Lookup](./schema.verb.md)<!-- -->, [LookupArgs](./schema.lookupargs.md)<!-- -->, [Verb.Merge](./schema.verb.md)<!-- -->, [MergeArgs](./schema.mergeargs.md)<!-- -->, [Verb.Onehot](./schema.verb.md)<!-- -->, [OnehotArgs](./schema.onehotargs.md)<!-- -->, [Verb.Orderby](./schema.verb.md)<!-- -->, [OrderbyArgs](./schema.orderbyargs.md)<!-- -->, [Verb.Pivot](./schema.verb.md)<!-- -->, [PivotArgs](./schema.pivotargs.md)<!-- -->, [Verb.Recode](./schema.verb.md)<!-- -->, [RecodeArgs](./schema.recodeargs.md)<!-- -->, [Verb.Rename](./schema.verb.md)<!-- -->, [RenameArgs](./schema.renameargs.md)<!-- -->, [Verb.Rollup](./schema.verb.md)<!-- -->, [RollupArgs](./schema.rollupargs.md)<!-- -->, [Verb.Sample](./schema.verb.md)<!-- -->, [SampleArgs](./schema.sampleargs.md)<!-- -->, [Verb.Select](./schema.verb.md)<!-- -->, [SelectArgs](./schema.selectargs.md)<!-- -->, [Verb.Spread](./schema.verb.md)<!-- -->, [SpreadArgs](./schema.spreadargs.md)<!-- -->, [Verb.Unfold](./schema.verb.md)<!-- -->, [UnfoldArgs](./schema.unfoldargs.md)<!-- -->, [Verb.Ungroup](./schema.verb.md)<!-- -->, [Verb.Unhot](./schema.verb.md)<!-- -->, [UnhotArgs](./schema.unhotargs.md)<!-- -->, [Verb.Union](./schema.verb.md)<!-- -->, [Verb.Unorder](./schema.verb.md)<!-- -->, [Verb.Unroll](./schema.verb.md)<!-- -->, [UnrollArgs](./schema.unrollargs.md)<!-- -->, [Verb.Window](./schema.verb.md)<!-- -->, [WindowArgs](./schema.windowargs.md)<!-- -->, [UnknownInput](./schema.unknowninput.md) | ||
@@ -19,2 +19,4 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
| --- | --- | --- | --- | | ||
| [arrayDelimiter?](./schema.typehints.arraydelimiter.md) | | string | <i>(Optional)</i> The character to use for delimiting arrays. | | ||
| [dataFormat?](./schema.typehints.dataformat.md) | | [DataFormat](./schema.dataformat.md) | <i>(Optional)</i> The data format | | ||
| [dateFormat?](./schema.typehints.dateformat.md) | | string | <i>(Optional)</i> Default date format to use when parsing dates. The Codebook can override this at the column level. Default: yyyy-MM-dd TODO: spark has a separate config for datetime. Do we care? | | ||
@@ -21,0 +23,0 @@ | [decimal?](./schema.typehints.decimal.md) | | string | <i>(Optional)</i> Character to use when parsing decimal numbers. Default: . | |
@@ -13,5 +13,5 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
input: { | ||
source: PortBinding; | ||
others?: PortBinding[]; | ||
source: WorkflowStepId; | ||
others?: WorkflowStepId[]; | ||
}; | ||
``` |
@@ -20,3 +20,3 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
| --- | --- | --- | --- | | ||
| [input](./schema.variadicinput.input.md) | | { source: [PortBinding](./schema.portbinding.md)<!-- -->; others?: [PortBinding](./schema.portbinding.md)<!-- -->\[\]; } | The step inputs; a required "source" and optional, variadic "others". If this is a string, it is used to bind the primary input. | | ||
| [input](./schema.variadicinput.input.md) | | { source: [WorkflowStepId](./schema.workflowstepid.md)<!-- -->; others?: [WorkflowStepId](./schema.workflowstepid.md)<!-- -->\[\]; } | The step inputs; a required "source" and optional, variadic "others". If this is a string, it is used to bind the primary input. | | ||
@@ -21,3 +21,3 @@ ## API Report File for "@datashaper/schema" | ||
input?: string | { | ||
source: PortBinding; | ||
source: WorkflowStepId; | ||
}; | ||
@@ -364,4 +364,4 @@ } | ||
input: { | ||
source: PortBinding; | ||
other: PortBinding; | ||
source: WorkflowStepId; | ||
other: WorkflowStepId; | ||
}; | ||
@@ -730,9 +730,2 @@ } | ||
// Warning: (ae-missing-release-tag) "NamedPortBinding" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) | ||
// | ||
// @public | ||
export interface NamedPortBinding { | ||
node: string; | ||
} | ||
// Warning: (ae-missing-release-tag) "NumericComparisonOperator" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) | ||
@@ -839,7 +832,2 @@ // | ||
// Warning: (ae-missing-release-tag) "PortBinding" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) | ||
// | ||
// @public (undocumented) | ||
export type PortBinding = string | NamedPortBinding; | ||
// Warning: (ae-missing-release-tag) "Profile" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) | ||
@@ -911,2 +899,3 @@ // | ||
proportion?: number; | ||
seed?: number; | ||
size?: number; | ||
@@ -1064,3 +1053,10 @@ } | ||
args?: WindowArgs; | ||
} & BasicInput)); | ||
} & BasicInput) | ||
/** | ||
* Custom step - we may not know the verb, args, or binding pattern | ||
*/ | ||
| ({ | ||
verb: string; | ||
args?: unknown; | ||
} & UnknownInput)); | ||
@@ -1108,2 +1104,4 @@ // Warning: (ae-missing-release-tag) "StepJsonCommon" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) | ||
export interface TypeHints { | ||
arrayDelimiter?: string; | ||
dataFormat?: DataFormat; | ||
dateFormat?: string; | ||
@@ -1138,2 +1136,14 @@ decimal?: string; | ||
// Warning: (ae-missing-release-tag) "UnknownInput" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) | ||
// | ||
// @public (undocumented) | ||
export interface UnknownInput { | ||
// (undocumented) | ||
input?: string | { | ||
source?: WorkflowStepId; | ||
others?: WorkflowStepId[]; | ||
[key: string]: WorkflowStepId | WorkflowStepId[] | undefined; | ||
}; | ||
} | ||
// Warning: (ae-missing-release-tag) "UnrollArgs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) | ||
@@ -1178,4 +1188,4 @@ // | ||
input: { | ||
source: PortBinding; | ||
others?: PortBinding[]; | ||
source: WorkflowStepId; | ||
others?: WorkflowStepId[]; | ||
}; | ||
@@ -1304,4 +1314,9 @@ } | ||
// Warning: (ae-missing-release-tag) "WorkflowStepId" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) | ||
// | ||
// @public | ||
export type WorkflowStepId = string; | ||
// (No @packageDocumentation comment for this package) | ||
``` |
{ | ||
"name": "@datashaper/schema", | ||
"version": "10.0.2", | ||
"version": "11.0.0", | ||
"type": "module", | ||
@@ -55,11 +55,11 @@ "main": "dist/index.js", | ||
"devDependencies": { | ||
"@essex/jest-config": "^21.0.21", | ||
"@essex/scripts": "^24.0.4", | ||
"@essex/jest-config": "^21.0.22", | ||
"@essex/scripts": "^24.0.5", | ||
"@essex/tsconfig-base": "^2.0.0", | ||
"@types/jest": "^29.5.0", | ||
"@types/jest": "^29.5.2", | ||
"jest": "^29.5.0", | ||
"npm-run-all": "^4.1.5", | ||
"shx": "^0.3.4", | ||
"typescript": "^5.0.4", | ||
"typescript-json-schema": "^0.56.0" | ||
"typescript": "^5.1.3", | ||
"typescript-json-schema": "^0.57.0" | ||
}, | ||
@@ -66,0 +66,0 @@ "dependencies": { |
@@ -6,2 +6,3 @@ /*! | ||
import { DataFormat } from '../data.js' | ||
import type { TypeHints } from './TypeHints.js' | ||
@@ -15,2 +16,4 @@ | ||
export const TypeHintsDefaults: Required<TypeHints> = { | ||
dataFormat: DataFormat.CSV, | ||
arrayDelimiter: ",", | ||
trueValues: ['true'], | ||
@@ -17,0 +20,0 @@ falseValues: ['false'], |
@@ -5,2 +5,5 @@ /*! | ||
*/ | ||
import type { DataFormat } from "../data.js" | ||
/** | ||
@@ -12,2 +15,10 @@ * Configuration values for interpreting data types when parsing a delimited file. | ||
/** | ||
* The data format | ||
*/ | ||
dataFormat?: DataFormat | ||
/** | ||
* The character to use for delimiting arrays. | ||
*/ | ||
arrayDelimiter?: string | ||
/** | ||
* Default: case-insenstive word "true". | ||
@@ -14,0 +25,0 @@ */ |
@@ -5,13 +5,7 @@ /*! | ||
*/ | ||
export type PortBinding = string | NamedPortBinding | ||
/** | ||
* An explicit step input binding | ||
* The Id of the step to which the input is bound | ||
*/ | ||
export interface NamedPortBinding { | ||
/** | ||
* The id of the input node to bind to | ||
*/ | ||
node: string | ||
} | ||
export type WorkflowStepId = string | ||
@@ -28,3 +22,3 @@ /** | ||
*/ | ||
input?: string | { source: PortBinding } | ||
input?: string | { source: WorkflowStepId } | ||
} | ||
@@ -43,3 +37,3 @@ | ||
*/ | ||
source: PortBinding | ||
source: WorkflowStepId | ||
@@ -49,3 +43,3 @@ /** | ||
*/ | ||
other: PortBinding | ||
other: WorkflowStepId | ||
} | ||
@@ -66,3 +60,3 @@ } | ||
*/ | ||
source: PortBinding | ||
source: WorkflowStepId | ||
@@ -72,4 +66,23 @@ /** | ||
*/ | ||
others?: PortBinding[] | ||
others?: WorkflowStepId[] | ||
} | ||
} | ||
export interface UnknownInput { | ||
input?: | ||
| string | ||
| { | ||
/** | ||
* Possible main input | ||
**/ | ||
source?: WorkflowStepId | ||
/** | ||
* Possible variadic input | ||
*/ | ||
others?: WorkflowStepId[] | ||
/** Possible other input */ | ||
[key: string]: WorkflowStepId | WorkflowStepId[] | undefined | ||
} | ||
} |
@@ -5,4 +5,9 @@ /*! | ||
*/ | ||
import type { BasicInput, DualInput, VariadicInput } from './bindings.js' | ||
import type { | ||
BasicInput, | ||
DualInput, | ||
UnknownInput, | ||
VariadicInput, | ||
} from './bindings.js' | ||
import type { | ||
AggregateArgs, | ||
@@ -93,2 +98,7 @@ BinArgs, | ||
| ({ verb: Verb.Window; args?: WindowArgs } & BasicInput) | ||
/** | ||
* Custom step - we may not know the verb, args, or binding pattern | ||
*/ | ||
| ({ verb: string; args?: unknown } & UnknownInput) | ||
) |
@@ -472,2 +472,3 @@ /*! | ||
size?: number | ||
/** | ||
@@ -479,2 +480,7 @@ * If table size is unknown ahead of time, specify a proportion of rows to sample. | ||
proportion?: number | ||
/** | ||
* The randomization seed to use for sampling to ensure stable sampling. | ||
*/ | ||
seed?: number | ||
} | ||
@@ -481,0 +487,0 @@ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
817375
432
16587