@datashaper/schema - npm Package Compare versions

Comparing version 7.0.0 to 7.0.1

dist/index.d.ts

@@ -12,2 +12,3 @@ /*!
 export * from './Named.js';
+export * from './validator.js';
 export * from './workflow/index.js';

dist/index.js

@@ -11,2 +11,3 @@ /*!
 export * from './Named.js';
+export * from './validator.js';
 export * from './workflow/index.js';

dist/workflow/Step.d.ts

@@ -6,3 +6,3 @@ /*!
 import type { BasicInput, DualInput, VariadicInput } from './bindings.js';
-import type { AggregateArgs, BinArgs, BinarizeArgs, BooleanArgs, ConvertArgs, DedupeArgs, DeriveArgs, 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';
+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';
 /**
@@ -46,2 +46,8 @@ * Common step properties
 } & VariadicInput) | ({
+    verb: Verb.Decode;
+    args?: EncodeDecodeArgs;
+} & BasicInput) | ({
+    verb: Verb.Encode;
+    args?: EncodeDecodeArgs;
+} & BasicInput) | ({
     verb: Verb.Erase;
@@ -48,0 +54,0 @@ args?: EraseArgs;

dist/workflow/verbs.d.ts

@@ -5,2 +5,3 @@ /*!
  */
+import type { CodebookSchema } from '../codebook/CodebookSchema.js';
 import type { DataType, Value } from '../data.js';
@@ -18,2 +19,4 @@ import type { SortDirection } from '../enums.js';
     Difference = "difference",
+    Decode = "decode",
+    Encode = "encode",
     Erase = "erase",
@@ -300,2 +303,20 @@ Fetch = "fetch",
 }
+export interface EncodeDecodeArgs {
+    strategy: CodebookStrategy;
+    codebook: CodebookSchema;
+}
+export interface FetchArgs {
+    /**
+     * URL where the csv file is located
+     */
+    url: string;
+    /**
+     * Optional delimiter for csv
+     */
+    delimiter?: string;
+    /**
+     * Optional autoMax for tables
+     */
+    autoMax?: number;
+}
 export interface FillArgs extends OutputColumnArgs {
@@ -344,2 +365,7 @@ /**
 }
+export declare enum CodebookStrategy {
+    DataTypeOnly = "data type only",
+    MappingOnly = "mapping only",
+    DataTypeAndMapping = "data type and mapping"
+}
 export interface LookupArgs extends JoinArgsBase, InputColumnListArgs {
@@ -346,0 +372,0 @@ }

dist/workflow/verbs.js

@@ -15,2 +15,4 @@ /*!
     Verb["Difference"] = 'difference';
+    Verb["Decode"] = 'decode';
+    Verb["Encode"] = 'encode';
     Verb["Erase"] = 'erase';
@@ -184,2 +186,8 @@ Verb["Fetch"] = 'fetch';
 })(JoinStrategy || (JoinStrategy = {}));
+export var CodebookStrategy;
+(function(CodebookStrategy) {
+    CodebookStrategy["DataTypeOnly"] = 'data type only';
+    CodebookStrategy["MappingOnly"] = 'mapping only';
+    CodebookStrategy["DataTypeAndMapping"] = 'data type and mapping';
+})(CodebookStrategy || (CodebookStrategy = {}));
 export var MergeStrategy;
@@ -186,0 +194,0 @@ (function(MergeStrategy) {

docs/markdown/schema.md

@@ -14,2 +14,3 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 |  [BooleanOperator](./schema.booleanoperator.md) |  |
+|  [CodebookStrategy](./schema.codebookstrategy.md) |  |
 |  [DataFormat](./schema.dataformat.md) | Base format the data is stored within. This will expand to include additional formats such as Arrow and Parquet over time. TODO: we've seen a number of examples in the wild using JSON Lines https://jsonlines.org/ |
@@ -41,2 +42,3 @@ |  [DataNature](./schema.datanature.md) | Indicates the expected general layout of the data. This could be used to provide validation hints. For example, microdata must have one row per subject. TODO: "timeseries" as distinct from "panel"? others? |
 |  [createDataTableSchemaObject(input)](./schema.createdatatableschemaobject.md) |  |
+|  [createSchemaValidator()](./schema.createschemavalidator.md) |  |
 |  [createWorkflowSchemaObject(input)](./schema.createworkflowschemaobject.md) |  |
@@ -64,3 +66,5 @@
 |  [DualInput](./schema.dualinput.md) | Dual-input, single-output step I/O |
+|  [EncodeDecodeArgs](./schema.encodedecodeargs.md) |  |
 |  [EraseArgs](./schema.eraseargs.md) |  |
+|  [FetchArgs](./schema.fetchargs.md) |  |
 |  [Field](./schema.field.md) | Contains the full schema definition and metadata for a data field (usually a table column). This includes the required data type, various data nature and rendering properties, potential validation rules, and mappings from a data dictionary. |
@@ -67,0 +71,0 @@ |  [FieldMetadata](./schema.fieldmetadata.md) | Holds core metadata/stats for a data field. |

docs/markdown/schema.step.md

@@ -38,2 +38,8 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 } & VariadicInput) | ({
+    verb: Verb.Decode;
+    args?: EncodeDecodeArgs;
+} & BasicInput) | ({
+    verb: Verb.Encode;
+    args?: EncodeDecodeArgs;
+} & BasicInput) | ({
     verb: Verb.Erase;
@@ -114,3 +120,3 @@ args?: EraseArgs;
 ```
-<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.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)
 

docs/markdown/schema.verb.md

@@ -23,5 +23,7 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 |  Convert | <code>&quot;convert&quot;</code> |  |
+|  Decode | <code>&quot;decode&quot;</code> |  |
 |  Dedupe | <code>&quot;dedupe&quot;</code> |  |
 |  Derive | <code>&quot;derive&quot;</code> |  |
 |  Difference | <code>&quot;difference&quot;</code> |  |
+|  Encode | <code>&quot;encode&quot;</code> |  |
 |  Erase | <code>&quot;erase&quot;</code> |  |
@@ -28,0 +30,0 @@ |  Fetch | <code>&quot;fetch&quot;</code> |  |

docs/report/schema.api.md

@@ -7,2 +7,4 @@ ## API Report File for "@datashaper/schema"
 
+import Ajv from 'ajv';
+
 // Warning: (ae-missing-release-tag) "AggregateArgs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -122,2 +124,14 @@ //
 
+// Warning: (ae-missing-release-tag) "CodebookStrategy" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export enum CodebookStrategy {
+    // (undocumented)
+    DataTypeAndMapping = "data type and mapping",
+    // (undocumented)
+    DataTypeOnly = "data type only",
+    // (undocumented)
+    MappingOnly = "mapping only"
+}
+
 // Warning: (ae-missing-release-tag) "Constraints" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -165,2 +179,7 @@ //
 
+// Warning: (ae-missing-release-tag) "createSchemaValidator" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createSchemaValidator(): Ajv;
+
 // Warning: (ae-missing-release-tag) "createWorkflowSchemaObject" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -313,2 +332,12 @@ //
 
+// Warning: (ae-missing-release-tag) "EncodeDecodeArgs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface EncodeDecodeArgs {
+    // (undocumented)
+    codebook: CodebookSchema;
+    // (undocumented)
+    strategy: CodebookStrategy;
+}
+
 // Warning: (ae-missing-release-tag) "EraseArgs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -330,2 +359,11 @@ //
 
+// Warning: (ae-missing-release-tag) "FetchArgs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface FetchArgs {
+    autoMax?: number;
+    delimiter?: string;
+    url: string;
+}
+
 // Warning: (ae-missing-release-tag) "Field" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -831,2 +869,8 @@ //
 } & VariadicInput) | ({
+    verb: Verb.Decode;
+    args?: EncodeDecodeArgs;
+} & BasicInput) | ({
+    verb: Verb.Encode;
+    args?: EncodeDecodeArgs;
+} & BasicInput) | ({
     verb: Verb.Erase;
@@ -1012,2 +1056,4 @@ args?: EraseArgs;
     // (undocumented)
+    Decode = "decode",
+    // (undocumented)
     Dedupe = "dedupe",
@@ -1019,2 +1065,4 @@ // (undocumented)
     // (undocumented)
+    Encode = "encode",
+    // (undocumented)
     Erase = "erase",
@@ -1021,0 +1069,0 @@ // (undocumented)

docsTemp/schema.api.md

@@ -7,2 +7,4 @@ ## API Report File for "@datashaper/schema"
 
+import Ajv from 'ajv';
+
 // Warning: (ae-missing-release-tag) "AggregateArgs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -122,2 +124,14 @@ //
 
+// Warning: (ae-missing-release-tag) "CodebookStrategy" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export enum CodebookStrategy {
+    // (undocumented)
+    DataTypeAndMapping = "data type and mapping",
+    // (undocumented)
+    DataTypeOnly = "data type only",
+    // (undocumented)
+    MappingOnly = "mapping only"
+}
+
 // Warning: (ae-missing-release-tag) "Constraints" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -165,2 +179,7 @@ //
 
+// Warning: (ae-missing-release-tag) "createSchemaValidator" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createSchemaValidator(): Ajv;
+
 // Warning: (ae-missing-release-tag) "createWorkflowSchemaObject" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -313,2 +332,12 @@ //
 
+// Warning: (ae-missing-release-tag) "EncodeDecodeArgs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface EncodeDecodeArgs {
+    // (undocumented)
+    codebook: CodebookSchema;
+    // (undocumented)
+    strategy: CodebookStrategy;
+}
+
 // Warning: (ae-missing-release-tag) "EraseArgs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -330,2 +359,11 @@ //
 
+// Warning: (ae-missing-release-tag) "FetchArgs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface FetchArgs {
+    autoMax?: number;
+    delimiter?: string;
+    url: string;
+}
+
 // Warning: (ae-missing-release-tag) "Field" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -831,2 +869,8 @@ //
 } & VariadicInput) | ({
+    verb: Verb.Decode;
+    args?: EncodeDecodeArgs;
+} & BasicInput) | ({
+    verb: Verb.Encode;
+    args?: EncodeDecodeArgs;
+} & BasicInput) | ({
     verb: Verb.Erase;
@@ -1012,2 +1056,4 @@ args?: EraseArgs;
     // (undocumented)
+    Decode = "decode",
+    // (undocumented)
     Dedupe = "dedupe",
@@ -1019,2 +1065,4 @@ // (undocumented)
     // (undocumented)
+    Encode = "encode",
+    // (undocumented)
     Erase = "erase",
@@ -1021,0 +1069,0 @@ // (undocumented)

package.json

 {
   "name": "@datashaper/schema",
-  "version": "7.0.0",
+  "version": "7.0.1",
   "type": "module",
@@ -37,4 +37,8 @@ "main": "dist/index.js",
     "clean": "essex clean dist docs",
-    "build": "node create_versions_file.js && essex build --docs",
+    "_create_versions_file": "node create_versions_file.js",
+    "_transpile": "essex build --docs",
+    "_bundle_schemas": "run-p bundle-codebook bundle-datapackage bundle-datatable bundle-workflow",
+    "build": "run-p _create_versions_file _transpile _bundle_schemas",
     "lint": "essex lint --fix",
+    "test": "NODE_OPTIONS=--experimental-vm-modules yarn node $(yarn bin jest) --runInBand",
     "bundle-codebook": "typescript-json-schema tsconfig.json CodebookSchema > ../../schema/codebook.json",
@@ -44,9 +48,11 @@ "bundle-datapackage": "typescript-json-schema tsconfig.json DataPackageSchema > ../../schema/datapackage.json",
     "bundle-workflow": "typescript-json-schema tsconfig.json WorkflowSchema > ../../schema/workflow.json",
-    "bundle": "yarn node create_versions_file.js && run-p bundle-codebook bundle-datapackage bundle-datatable bundle-workflow",
     "release": "yarn npm publish --tolerate-republish --access public"
   },
   "devDependencies": {
+    "@essex/jest-config": "^21.0.16",
     "@essex/scripts": "^22.1.0",
     "@essex/tsconfig-base": "^1.0.2",
+    "@types/jest": "^29.2.0",
     "@types/uuid": "^8.3.4",
+    "jest": "^29.2.1",
     "npm-run-all": "^4.1.5",
@@ -58,2 +64,4 @@ "shx": "^0.3.4",
   "dependencies": {
+    "ajv": "^8.11.0",
+    "ajv-formats": "^2.1.1",
     "uuid": "^9.0.0"
@@ -60,0 +68,0 @@ },

src/index.ts

@@ -12,2 +12,3 @@ /*!
 export * from './Named.js'
+export * from './validator.js'
 export * from './workflow/index.js'

src/workflow/Step.ts

@@ -14,2 +14,3 @@ /*!
 	DeriveArgs,
+	EncodeDecodeArgs,
 	EraseArgs,
@@ -64,2 +65,4 @@ FillArgs,
 		| ({ verb: Verb.Difference } & VariadicInput)
+		| ({ verb: Verb.Decode; args?: EncodeDecodeArgs } & BasicInput)
+		| ({ verb: Verb.Encode; args?: EncodeDecodeArgs } & BasicInput)
 		| ({ verb: Verb.Erase; args?: EraseArgs } & BasicInput)
@@ -66,0 +69,0 @@ | ({ verb: Verb.Fill; args?: FillArgs } & BasicInput)

src/workflow/verbs.ts

@@ -5,2 +5,3 @@ /*!
  */
+import type { CodebookSchema } from '../codebook/CodebookSchema.js'
 import type { DataType, Value } from '../data.js'
@@ -19,2 +20,4 @@ import type { SortDirection } from '../enums.js'
 	Difference = 'difference',
+	Decode = 'decode',
+	Encode = 'encode',
 	Erase = 'erase',
@@ -334,2 +337,23 @@ Fetch = 'fetch',
 
+export interface EncodeDecodeArgs {
+	strategy: CodebookStrategy
+
+	codebook: CodebookSchema
+}
+
+export interface FetchArgs {
+	/**
+	 * URL where the csv file is located
+	 */
+	url: string
+	/**
+	 * Optional delimiter for csv
+	 */
+	delimiter?: string
+	/**
+	 * Optional autoMax for tables
+	 */
+	autoMax?: number
+}
+
 export interface FillArgs extends OutputColumnArgs {
@@ -386,2 +410,8 @@ /**
 
+export enum CodebookStrategy {
+	DataTypeOnly = 'data type only',
+	MappingOnly = 'mapping only',
+	DataTypeAndMapping = 'data type and mapping',
+}
+
 export interface LookupArgs extends JoinArgsBase, InputColumnListArgs {}
@@ -388,0 +418,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

750899

increased by3.63%

Number of package files

354

increased by4.42%

Lines of code

14602

increased by3.74%

Worsened metrics

Dependency count

3

increased by200%

Dev dependency count

10

increased by42.86%

Dependency changes

• + Addedajv@^8.11.0

• + Addedajv-formats@^2.1.1

• + Addedajv@8.17.1(transitive)

• + Addedajv-formats@2.1.1(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-uri@3.0.3(transitive)

• + Addedjson-schema-traverse@1.0.0(transitive)

• + Addedrequire-from-string@2.0.2(transitive)