@flatfile/blueprint - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

dist/index.d.ts

@@ -35,2 +35,5 @@ declare type ArrayableProperty = {
     type?: 'string' | 'number' | 'boolean' | 'date' | 'enum' | 'reference';
+    /**
+     * User friendly field name
+     */
     label?: string;
@@ -42,2 +45,3 @@ description?: string;
 declare type BooleanProperty = (BaseProperty & {
+    type?: 'boolean';
     config?: {
@@ -51,3 +55,5 @@ /**
 
-declare type DateProperty = BaseProperty;
+declare type DateProperty = (BaseProperty & {
+    type?: 'date';
+});
 
@@ -78,2 +84,3 @@ declare type EnumPropertyOption = {
 declare type EnumProperty = (BaseProperty & ArrayableProperty & {
+    type?: 'enum';
     config: {
@@ -89,2 +96,3 @@ /**
 declare type NumberProperty = (BaseProperty & ArrayableProperty & {
+    type?: 'number';
     /**
@@ -102,2 +110,3 @@ * Optional configuration
 declare type ReferenceProperty = (BaseProperty & ArrayableProperty & {
+    type?: 'reference';
     config: {
@@ -115,3 +124,5 @@ /**
 
-declare type StringProperty = BaseProperty;
+declare type StringProperty = (BaseProperty & {
+    type?: 'string';
+});
 
@@ -122,2 +133,11 @@ declare type Property = (StringProperty | NumberProperty | BooleanProperty | DateProperty | EnumProperty | ReferenceProperty);
 
-export { ArrayableProperty, BaseConstraint, BaseProperty, BooleanProperty, Constraint, DateProperty, EnumProperty, EnumPropertyOption, NumberProperty, Property, PropertyList, ReferenceProperty, RequiredConstraint, StringProperty, UniqueConstraint };
+/**
+ * Describes shape of data as well as behavior
+ */
+declare type SheetConfig = {
+    name: string;
+    description?: string;
+    fields: Array<Property>;
+};
+
+export { ArrayableProperty, BaseConstraint, BaseProperty, BooleanProperty, Constraint, DateProperty, EnumProperty, EnumPropertyOption, NumberProperty, Property, PropertyList, ReferenceProperty, RequiredConstraint, SheetConfig, StringProperty, UniqueConstraint };

package.json

 {
   "name": "@flatfile/blueprint",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "The universal DDL for defining data structures across Flatfile.",
@@ -5,0 +5,0 @@ "main": "./dist/index.js",

New alerts

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

23994

increased by8.2%

Lines of code

135

increased by16.38%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes