@datashaper/schema - npm Package Compare versions

Comparing version 5.0.0 to 6.0.0

dist/index.d.ts

@@ -10,2 +10,3 @@ /*!
 export * from './enums.js';
+export * from './factories.js';
 export * from './workflow/index.js';

dist/index.js

@@ -9,2 +9,3 @@ /*!
 export * from './enums.js';
+export * from './factories.js';
 export * from './workflow/index.js';

dist/workflow/verbs.d.ts

@@ -5,3 +5,3 @@ /*!
  */
-import type { Value } from '../data.js';
+import type { DataType, Value } from '../data.js';
 import type { SortDirection } from '../enums.js';
@@ -51,2 +51,3 @@ export declare enum Verb {
     column: string;
+    dataType?: DataType;
 }
@@ -265,3 +266,3 @@ /**
 }
-export interface ConvertArgs extends InputColumnListArgs {
+export interface ConvertArgs extends InputColumnArgs {
     type: ParseType;
@@ -287,3 +288,3 @@ /**
 }
-export interface EraseArgs extends InputColumnListArgs {
+export interface EraseArgs extends InputColumnArgs {
     value: Value;
@@ -322,3 +323,3 @@ }
 export declare type GroupbyArgs = InputColumnListArgs;
-export interface ImputeArgs extends InputColumnListArgs {
+export interface ImputeArgs extends InputColumnArgs {
     /**
@@ -368,7 +369,7 @@ * Value to fill in empty cells
 }
-export interface OnehotArgs extends InputColumnListArgs {
+export interface OnehotArgs extends InputColumnArgs {
     /**
      * Optional prefixes for the output column names
      */
-    prefixes?: Record<string, string>;
+    prefix?: string;
     preserveSource?: boolean;
@@ -419,3 +420,3 @@ }
 export declare type SelectArgs = InputColumnListArgs;
-export interface SpreadArgs extends InputColumnListArgs {
+export interface SpreadArgs extends InputColumnArgs {
     to: string[];
@@ -422,0 +423,0 @@ /**

docs/schema.api.md

@@ -138,3 +138,3 @@ ## API Report File for "@datashaper/schema"
 // @public (undocumented)
-export interface ConvertArgs extends InputColumnListArgs {
+export interface ConvertArgs extends InputColumnArgs {
     // (undocumented)
@@ -149,2 +149,22 @@ delimiter?: string;
 
+// Warning: (ae-missing-release-tag) "createCodebookSchemaObject" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createCodebookSchemaObject(input: FactoryInput<CodebookSchema>): CodebookSchema;
+
+// Warning: (ae-missing-release-tag) "createDataPackageSchemaObject" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createDataPackageSchemaObject(input: FactoryInput<DataPackageSchema>): DataPackageSchema;
+
+// Warning: (ae-missing-release-tag) "createDataTableSchemaObject" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createDataTableSchemaObject(input: FactoryInput<DataTableSchema>): DataTableSchema;
+
+// Warning: (ae-missing-release-tag) "createWorkflowSchemaObject" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createWorkflowSchemaObject(input: FactoryInput<WorkflowSchema>): WorkflowSchema;
+
 // Warning: (ae-missing-release-tag) "Criterion" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -287,3 +307,3 @@ //
 // @public (undocumented)
-export interface EraseArgs extends InputColumnListArgs {
+export interface EraseArgs extends InputColumnArgs {
     // (undocumented)
@@ -293,2 +313,10 @@ value: Value;
 
+// Warning: (ae-missing-release-tag) "FactoryInput" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type FactoryInput<T> = Omit<T, '$schema' | 'id' | 'name'> & {
+    id?: string;
+    name?: string;
+};
+
 // Warning: (ae-missing-release-tag) "FetchArgs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -422,3 +450,3 @@ //
 // @public (undocumented)
-export interface ImputeArgs extends InputColumnListArgs {
+export interface ImputeArgs extends InputColumnArgs {
     value: Value;
@@ -432,2 +460,4 @@ }
     column: string;
+    // (undocumented)
+    dataType?: DataType;
 }
@@ -485,2 +515,22 @@
 
+// Warning: (ae-missing-release-tag) "LATEST_CODEBOOK_SCHEMA" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const LATEST_CODEBOOK_SCHEMA: string;
+
+// Warning: (ae-missing-release-tag) "LATEST_DATAPACKAGE_SCHEMA" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const LATEST_DATAPACKAGE_SCHEMA: string;
+
+// Warning: (ae-missing-release-tag) "LATEST_DATATABLE_SCHEMA" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const LATEST_DATATABLE_SCHEMA: string;
+
+// Warning: (ae-missing-release-tag) "LATEST_WORKFLOW_SCHEMA" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const LATEST_WORKFLOW_SCHEMA: string;
+
 // Warning: (ae-missing-release-tag) "LookupArgs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -575,4 +625,4 @@ //
 // @public (undocumented)
-export interface OnehotArgs extends InputColumnListArgs {
-    prefixes?: Record<string, string>;
+export interface OnehotArgs extends InputColumnArgs {
+    prefix?: string;
     // (undocumented)
@@ -734,3 +784,3 @@ preserveSource?: boolean;
 // @public (undocumented)
-export interface SpreadArgs extends InputColumnListArgs {
+export interface SpreadArgs extends InputColumnArgs {
     delimiter?: string;
@@ -737,0 +787,0 @@ onehot?: boolean;

docsTemp/schema.api.md

@@ -138,3 +138,3 @@ ## API Report File for "@datashaper/schema"
 // @public (undocumented)
-export interface ConvertArgs extends InputColumnListArgs {
+export interface ConvertArgs extends InputColumnArgs {
     // (undocumented)
@@ -149,2 +149,22 @@ delimiter?: string;
 
+// Warning: (ae-missing-release-tag) "createCodebookSchemaObject" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createCodebookSchemaObject(input: FactoryInput<CodebookSchema>): CodebookSchema;
+
+// Warning: (ae-missing-release-tag) "createDataPackageSchemaObject" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createDataPackageSchemaObject(input: FactoryInput<DataPackageSchema>): DataPackageSchema;
+
+// Warning: (ae-missing-release-tag) "createDataTableSchemaObject" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createDataTableSchemaObject(input: FactoryInput<DataTableSchema>): DataTableSchema;
+
+// Warning: (ae-missing-release-tag) "createWorkflowSchemaObject" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createWorkflowSchemaObject(input: FactoryInput<WorkflowSchema>): WorkflowSchema;
+
 // Warning: (ae-missing-release-tag) "Criterion" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -287,3 +307,3 @@ //
 // @public (undocumented)
-export interface EraseArgs extends InputColumnListArgs {
+export interface EraseArgs extends InputColumnArgs {
     // (undocumented)
@@ -293,2 +313,10 @@ value: Value;
 
+// Warning: (ae-missing-release-tag) "FactoryInput" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type FactoryInput<T> = Omit<T, '$schema' | 'id' | 'name'> & {
+    id?: string;
+    name?: string;
+};
+
 // Warning: (ae-missing-release-tag) "FetchArgs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -422,3 +450,3 @@ //
 // @public (undocumented)
-export interface ImputeArgs extends InputColumnListArgs {
+export interface ImputeArgs extends InputColumnArgs {
     value: Value;
@@ -432,2 +460,4 @@ }
     column: string;
+    // (undocumented)
+    dataType?: DataType;
 }
@@ -485,2 +515,22 @@
 
+// Warning: (ae-missing-release-tag) "LATEST_CODEBOOK_SCHEMA" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const LATEST_CODEBOOK_SCHEMA: string;
+
+// Warning: (ae-missing-release-tag) "LATEST_DATAPACKAGE_SCHEMA" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const LATEST_DATAPACKAGE_SCHEMA: string;
+
+// Warning: (ae-missing-release-tag) "LATEST_DATATABLE_SCHEMA" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const LATEST_DATATABLE_SCHEMA: string;
+
+// Warning: (ae-missing-release-tag) "LATEST_WORKFLOW_SCHEMA" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const LATEST_WORKFLOW_SCHEMA: string;
+
 // Warning: (ae-missing-release-tag) "LookupArgs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -575,4 +625,4 @@ //
 // @public (undocumented)
-export interface OnehotArgs extends InputColumnListArgs {
-    prefixes?: Record<string, string>;
+export interface OnehotArgs extends InputColumnArgs {
+    prefix?: string;
     // (undocumented)
@@ -734,3 +784,3 @@ preserveSource?: boolean;
 // @public (undocumented)
-export interface SpreadArgs extends InputColumnListArgs {
+export interface SpreadArgs extends InputColumnArgs {
     delimiter?: string;
@@ -737,0 +787,0 @@ onehot?: boolean;

package.json

 {
   "name": "@datashaper/schema",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "type": "module",
@@ -37,3 +37,3 @@ "main": "dist/index.js",
     "clean": "essex clean dist docs",
-    "build": "essex build --docs --skipExportCheck",
+    "build": "node create_versions_file.js && essex build --docs",
     "lint": "essex lint --fix",
@@ -48,4 +48,5 @@ "bundle-codebook": "typescript-json-schema tsconfig.json CodebookSchema > ../../schema/codebook.json",
   "devDependencies": {
-    "@essex/scripts": "^22.0.7",
+    "@essex/scripts": "^22.0.8",
     "@essex/tsconfig-base": "^1.0.2",
+    "@types/uuid": "^8.3.4",
     "npm-run-all": "^4.1.5",
@@ -56,3 +57,6 @@ "shx": "^0.3.4",
   },
+  "dependencies": {
+    "uuid": "^9.0.0"
+  },
   "types": "dist/index.d.ts"
 }

src/index.ts

@@ -10,2 +10,3 @@ /*!
 export * from './enums.js'
+export * from './factories.js'
 export * from './workflow/index.js'

src/workflow/verbs.ts

@@ -5,3 +5,3 @@ /*!
  */
-import type { Value } from '../data.js'
+import type { DataType, Value } from '../data.js'
 import type { SortDirection } from '../enums.js'
@@ -53,2 +53,3 @@
 	column: string
+	dataType?: DataType
 }
@@ -291,3 +292,3 @@
 
-export interface ConvertArgs extends InputColumnListArgs {
+export interface ConvertArgs extends InputColumnArgs {
 	type: ParseType
@@ -319,3 +320,3 @@ /**
 
-export interface EraseArgs extends InputColumnListArgs {
+export interface EraseArgs extends InputColumnArgs {
 	value: Value
@@ -360,3 +361,3 @@ }
 
-export interface ImputeArgs extends InputColumnListArgs {
+export interface ImputeArgs extends InputColumnArgs {
 	/**
@@ -412,7 +413,7 @@ * Value to fill in empty cells
 
-export interface OnehotArgs extends InputColumnListArgs {
+export interface OnehotArgs extends InputColumnArgs {
 	/**
 	 * Optional prefixes for the output column names
 	 */
-	prefixes?: Record<string, string>
+	prefix?: string
 	preserveSource?: boolean
@@ -472,3 +473,3 @@ }
 
-export interface SpreadArgs extends InputColumnListArgs {
+export interface SpreadArgs extends InputColumnArgs {
 	to: string[]
@@ -475,0 +476,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

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

250112

increased by6.13%

Number of package files

109

increased by6.86%

Lines of code

4264

increased by3.67%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

1

increased byInfinity%

Dev dependency count

7

increased by16.67%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addeduuid@^9.0.0

• + Addeduuid@9.0.1(transitive)