@sprucelabs/spruce-file-utils 17.0.1 → 18.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/build/.spruce/schemas/schemas.types.d.ts +260 -147
  2. package/build/esm/.spruce/schemas/schemas.types.d.ts +260 -147
  3. package/build/esm/uploading/LocalUploadStrategy.d.ts +2 -0
  4. package/build/esm/uploading/LocalUploadStrategy.js +2 -0
  5. package/build/esm/uploading/S3UploadStrategy.d.ts +3 -3
  6. package/build/esm/uploading/S3UploadStrategy.js +3 -3
  7. package/build/uploading/LocalUploadStrategy.d.ts +2 -0
  8. package/build/uploading/LocalUploadStrategy.js +2 -0
  9. package/build/uploading/S3UploadStrategy.d.ts +3 -3
  10. package/build/uploading/S3UploadStrategy.js +3 -3
  11. package/package.json +1 -1
package/build/esm/.spruce/schemas/schemas.types.d.ts CHANGED
@@ -593,6 +593,43 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
593
593
  interface UpsertThemeEmitTargetEntity extends SchemaEntity<SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeEmitTargetSchema> {
594
594
  }
595
595
  }
596
+ namespace SpruceSchemas.Heartwood.v2021_02_11 {
597
+ interface Theme {
598
+ 'slug': string;
599
+ 'name': string;
600
+ 'props': SpruceSchemas.HeartwoodViewControllers.v2021_02_11.ThemeProps;
601
+ }
602
+ interface ThemeSchema extends SpruceSchema.Schema {
603
+ id: 'theme';
604
+ version: 'v2021_02_11';
605
+ namespace: 'Heartwood';
606
+ name: 'Theme';
607
+ fields: {
608
+ /** . */
609
+ 'slug': {
610
+ type: 'id';
611
+ isRequired: true;
612
+ options: undefined;
613
+ };
614
+ /** . */
615
+ 'name': {
616
+ type: 'text';
617
+ isRequired: true;
618
+ options: undefined;
619
+ };
620
+ /** . */
621
+ 'props': {
622
+ type: 'schema';
623
+ isRequired: true;
624
+ options: {
625
+ schema: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.ThemePropsSchema;
626
+ };
627
+ };
628
+ };
629
+ }
630
+ interface ThemeEntity extends SchemaEntity<SpruceSchemas.Heartwood.v2021_02_11.ThemeSchema> {
631
+ }
632
+ }
596
633
  namespace SpruceSchemas.Heartwood.v2021_02_11 {
597
634
  interface UpsertThemeEmitPayload {
598
635
  'theme': SpruceSchemas.Heartwood.v2021_02_11.Theme;
@@ -659,168 +696,217 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
659
696
  }
660
697
  }
661
698
  namespace SpruceSchemas.Heartwood.v2021_02_11 {
662
- interface Theme {
663
- 'slug': string;
664
- 'name': string;
665
- 'props': SpruceSchemas.HeartwoodViewControllers.v2021_02_11.ThemeProps;
699
+ interface UpsertThemeResponsePayload {
700
+ 'theme': SpruceSchemas.Heartwood.v2021_02_11.Theme;
666
701
  }
667
- interface ThemeSchema extends SpruceSchema.Schema {
668
- id: 'theme';
702
+ interface UpsertThemeResponsePayloadSchema extends SpruceSchema.Schema {
703
+ id: 'upsertThemeResponsePayload';
669
704
  version: 'v2021_02_11';
670
705
  namespace: 'Heartwood';
671
- name: 'Theme';
706
+ name: '';
672
707
  fields: {
673
708
  /** . */
674
- 'slug': {
675
- type: 'id';
676
- isRequired: true;
677
- options: undefined;
678
- };
679
- /** . */
680
- 'name': {
681
- type: 'text';
682
- isRequired: true;
683
- options: undefined;
684
- };
685
- /** . */
686
- 'props': {
709
+ 'theme': {
687
710
  type: 'schema';
688
711
  isRequired: true;
689
712
  options: {
690
- schema: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.ThemePropsSchema;
713
+ schema: SpruceSchemas.Heartwood.v2021_02_11.ThemeSchema;
691
714
  };
692
715
  };
693
716
  };
694
717
  }
695
- interface ThemeEntity extends SchemaEntity<SpruceSchemas.Heartwood.v2021_02_11.ThemeSchema> {
718
+ interface UpsertThemeResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeResponsePayloadSchema> {
696
719
  }
697
720
  }
698
- namespace SpruceSchemas.Heartwood.v2021_02_11 {
699
- interface UpsertThemeResponsePayload {
700
- 'theme': SpruceSchemas.Heartwood.v2021_02_11.Theme;
721
+ namespace SpruceSchemas.Files.v2022_05_13 {
722
+ interface SaveLocalSettingsEmitTarget {
723
+ 'organizationId': string;
701
724
  }
702
- interface UpsertThemeResponsePayloadSchema extends SpruceSchema.Schema {
703
- id: 'upsertThemeResponsePayload';
704
- version: 'v2021_02_11';
705
- namespace: 'Heartwood';
725
+ interface SaveLocalSettingsEmitTargetSchema extends SpruceSchema.Schema {
726
+ id: 'saveLocalSettingsEmitTarget';
727
+ version: 'v2022_05_13';
728
+ namespace: 'Files';
706
729
  name: '';
707
730
  fields: {
708
731
  /** . */
709
- 'theme': {
710
- type: 'schema';
732
+ 'organizationId': {
733
+ type: 'id';
711
734
  isRequired: true;
712
- options: {
713
- schema: SpruceSchemas.Heartwood.v2021_02_11.ThemeSchema;
714
- };
735
+ options: undefined;
715
736
  };
716
737
  };
717
738
  }
718
- interface UpsertThemeResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeResponsePayloadSchema> {
739
+ interface SaveLocalSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTargetSchema> {
719
740
  }
720
741
  }
721
742
  namespace SpruceSchemas.Files.v2022_05_13 {
722
- interface GetUploadEndpointResponsePayload {
723
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
724
- 'restEndpointUrl'?: string | undefined | null;
743
+ interface SaveLocalSettingsEmitPayload {
744
+ /** Local Upload Directory. */
745
+ 'localUploadDir': string;
746
+ /** File Host URL. */
747
+ 'fileHostUrl': string;
725
748
  }
726
- interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
727
- id: 'getUploadEndpointResponsePayload';
749
+ interface SaveLocalSettingsEmitPayloadSchema extends SpruceSchema.Schema {
750
+ id: 'saveLocalSettingsEmitPayload';
728
751
  version: 'v2022_05_13';
729
752
  namespace: 'Files';
730
753
  name: '';
731
754
  fields: {
732
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
733
- 'restEndpointUrl': {
755
+ /** Local Upload Directory. */
756
+ 'localUploadDir': {
757
+ label: 'Local Upload Directory';
734
758
  type: 'text';
735
- hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
759
+ isRequired: true;
760
+ options: undefined;
761
+ };
762
+ /** File Host URL. */
763
+ 'fileHostUrl': {
764
+ label: 'File Host URL';
765
+ type: 'text';
766
+ isRequired: true;
736
767
  options: undefined;
737
768
  };
738
769
  };
739
770
  }
740
- interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
771
+ interface SaveLocalSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitPayloadSchema> {
741
772
  }
742
773
  }
743
774
  namespace SpruceSchemas.Files.v2022_05_13 {
744
- interface UploadEmitTarget {
745
- 'locationId'?: string | undefined | null;
746
- 'organizationId'?: string | undefined | null;
747
- 'filePersonId'?: string | undefined | null;
775
+ interface SaveLocalSettingsEmitTargetAndPayload {
776
+ /** Source. */
777
+ 'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
778
+ 'target': SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTarget;
779
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitPayload;
748
780
  }
749
- interface UploadEmitTargetSchema extends SpruceSchema.Schema {
750
- id: 'uploadEmitTarget';
781
+ interface SaveLocalSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
782
+ id: 'saveLocalSettingsEmitTargetAndPayload';
751
783
  version: 'v2022_05_13';
752
784
  namespace: 'Files';
753
785
  name: '';
754
786
  fields: {
755
- /** . */
756
- 'locationId': {
757
- type: 'id';
758
- options: undefined;
787
+ /** Source. */
788
+ 'source': {
789
+ label: 'Source';
790
+ type: 'schema';
791
+ options: {
792
+ schema: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSourceSchema;
793
+ };
759
794
  };
760
795
  /** . */
761
- 'organizationId': {
762
- type: 'id';
763
- options: undefined;
796
+ 'target': {
797
+ type: 'schema';
798
+ isRequired: true;
799
+ options: {
800
+ schema: SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTargetSchema;
801
+ };
764
802
  };
765
803
  /** . */
766
- 'filePersonId': {
767
- type: 'text';
768
- options: undefined;
804
+ 'payload': {
805
+ type: 'schema';
806
+ isRequired: true;
807
+ options: {
808
+ schema: SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitPayloadSchema;
809
+ };
769
810
  };
770
811
  };
771
812
  }
772
- interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
813
+ interface SaveLocalSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTargetAndPayloadSchema> {
773
814
  }
774
815
  }
775
816
  namespace SpruceSchemas.Files.v2022_05_13 {
776
- interface UploadEmitPayload {
777
- 'base64Body': string;
778
- 'name': string;
817
+ interface SaveLocalSettingsResponsePayload {
818
+ 'wasSuccessful': boolean;
779
819
  }
780
- interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
781
- id: 'uploadEmitPayload';
820
+ interface SaveLocalSettingsResponsePayloadSchema extends SpruceSchema.Schema {
821
+ id: 'saveLocalSettingsResponsePayload';
782
822
  version: 'v2022_05_13';
783
823
  namespace: 'Files';
784
824
  name: '';
785
825
  fields: {
786
826
  /** . */
787
- 'base64Body': {
788
- type: 'text';
827
+ 'wasSuccessful': {
828
+ type: 'boolean';
789
829
  isRequired: true;
790
830
  options: undefined;
791
831
  };
832
+ };
833
+ }
834
+ interface SaveLocalSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsResponsePayloadSchema> {
835
+ }
836
+ }
837
+ namespace SpruceSchemas.Files.v2022_05_13 {
838
+ interface GetSettingsStatusEmitTarget {
839
+ 'organizationId': string;
840
+ }
841
+ interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
842
+ id: 'getSettingsStatusEmitTarget';
843
+ version: 'v2022_05_13';
844
+ namespace: 'Files';
845
+ name: '';
846
+ fields: {
792
847
  /** . */
793
- 'name': {
794
- type: 'text';
848
+ 'organizationId': {
849
+ type: 'id';
795
850
  isRequired: true;
796
851
  options: undefined;
797
852
  };
798
853
  };
799
854
  }
800
- interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
855
+ interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
801
856
  }
802
857
  }
803
858
  namespace SpruceSchemas.Files.v2022_05_13 {
804
- interface UploadResponsePayload {
805
- 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
859
+ interface GetSettingsStatusEmitTargetAndPayload {
860
+ /** Source. */
861
+ 'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
862
+ 'target': SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTarget;
806
863
  }
807
- interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
808
- id: 'uploadResponsePayload';
864
+ interface GetSettingsStatusEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
865
+ id: 'getSettingsStatusEmitTargetAndPayload';
809
866
  version: 'v2022_05_13';
810
867
  namespace: 'Files';
811
868
  name: '';
812
869
  fields: {
870
+ /** Source. */
871
+ 'source': {
872
+ label: 'Source';
873
+ type: 'schema';
874
+ options: {
875
+ schema: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSourceSchema;
876
+ };
877
+ };
813
878
  /** . */
814
- 'file': {
879
+ 'target': {
815
880
  type: 'schema';
816
881
  isRequired: true;
817
882
  options: {
818
- schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
883
+ schema: SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema;
819
884
  };
820
885
  };
821
886
  };
822
887
  }
823
- interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
888
+ interface GetSettingsStatusEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetAndPayloadSchema> {
889
+ }
890
+ }
891
+ namespace SpruceSchemas.Files.v2022_05_13 {
892
+ interface GetSettingsStatusResponsePayload {
893
+ 'didSupplyS3Creds': boolean;
894
+ }
895
+ interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
896
+ id: 'getSettingsStatusResponsePayload';
897
+ version: 'v2022_05_13';
898
+ namespace: 'Files';
899
+ name: '';
900
+ fields: {
901
+ /** . */
902
+ 'didSupplyS3Creds': {
903
+ type: 'boolean';
904
+ isRequired: true;
905
+ options: undefined;
906
+ };
907
+ };
908
+ }
909
+ interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
824
910
  }
825
911
  }
826
912
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -846,11 +932,9 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
846
932
  }
847
933
  namespace SpruceSchemas.Files.v2022_05_13 {
848
934
  interface SaveSettingsEmitPayload {
849
- 'awsAccessKeyId'?: string | undefined | null;
850
- 'awsSecretAccessKey'?: string | undefined | null;
851
- 'awsS3Bucket'?: string | undefined | null;
852
- 'localUploadDir'?: string | undefined | null;
853
- 'fileHostUrl'?: string | undefined | null;
935
+ 'awsAccessKeyId': string;
936
+ 'awsSecretAccessKey': string;
937
+ 'awsS3Bucket': string;
854
938
  }
855
939
  interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
856
940
  id: 'saveSettingsEmitPayload';
@@ -861,26 +945,19 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
861
945
  /** . */
862
946
  'awsAccessKeyId': {
863
947
  type: 'id';
948
+ isRequired: true;
864
949
  options: undefined;
865
950
  };
866
951
  /** . */
867
952
  'awsSecretAccessKey': {
868
953
  type: 'text';
954
+ isRequired: true;
869
955
  options: undefined;
870
956
  };
871
957
  /** . */
872
958
  'awsS3Bucket': {
873
959
  type: 'text';
874
- options: undefined;
875
- };
876
- /** . */
877
- 'localUploadDir': {
878
- type: 'text';
879
- options: undefined;
880
- };
881
- /** . */
882
- 'fileHostUrl': {
883
- type: 'text';
960
+ isRequired: true;
884
961
  options: undefined;
885
962
  };
886
963
  };
@@ -893,7 +970,7 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
893
970
  /** Source. */
894
971
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
895
972
  'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
896
- 'payload'?: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload | undefined | null;
973
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
897
974
  }
898
975
  interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
899
976
  id: 'saveSettingsEmitTargetAndPayload';
@@ -920,6 +997,7 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
920
997
  /** . */
921
998
  'payload': {
922
999
  type: 'schema';
1000
+ isRequired: true;
923
1001
  options: {
924
1002
  schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
925
1003
  };
@@ -951,75 +1029,74 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
951
1029
  }
952
1030
  }
953
1031
  namespace SpruceSchemas.Files.v2022_05_13 {
954
- interface UploadEmitTargetAndPayload {
955
- /** Source. */
956
- 'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
957
- 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
958
- 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1032
+ interface UploadEmitTarget {
1033
+ 'locationId'?: string | undefined | null;
1034
+ 'organizationId'?: string | undefined | null;
1035
+ 'filePersonId'?: string | undefined | null;
959
1036
  }
960
- interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
961
- id: 'uploadEmitTargetAndPayload';
1037
+ interface UploadEmitTargetSchema extends SpruceSchema.Schema {
1038
+ id: 'uploadEmitTarget';
962
1039
  version: 'v2022_05_13';
963
1040
  namespace: 'Files';
964
1041
  name: '';
965
1042
  fields: {
966
- /** Source. */
967
- 'source': {
968
- label: 'Source';
969
- type: 'schema';
970
- options: {
971
- schema: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSourceSchema;
972
- };
1043
+ /** . */
1044
+ 'locationId': {
1045
+ type: 'id';
1046
+ options: undefined;
973
1047
  };
974
1048
  /** . */
975
- 'target': {
976
- type: 'schema';
977
- options: {
978
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
979
- };
1049
+ 'organizationId': {
1050
+ type: 'id';
1051
+ options: undefined;
980
1052
  };
981
1053
  /** . */
982
- 'payload': {
983
- type: 'schema';
984
- isRequired: true;
985
- options: {
986
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
987
- };
1054
+ 'filePersonId': {
1055
+ type: 'text';
1056
+ options: undefined;
988
1057
  };
989
1058
  };
990
1059
  }
991
- interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1060
+ interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
992
1061
  }
993
1062
  }
994
1063
  namespace SpruceSchemas.Files.v2022_05_13 {
995
- interface GetSettingsStatusEmitTarget {
996
- 'organizationId': string;
1064
+ interface UploadEmitPayload {
1065
+ 'base64Body': string;
1066
+ 'name': string;
997
1067
  }
998
- interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
999
- id: 'getSettingsStatusEmitTarget';
1068
+ interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
1069
+ id: 'uploadEmitPayload';
1000
1070
  version: 'v2022_05_13';
1001
1071
  namespace: 'Files';
1002
1072
  name: '';
1003
1073
  fields: {
1004
1074
  /** . */
1005
- 'organizationId': {
1006
- type: 'id';
1075
+ 'base64Body': {
1076
+ type: 'text';
1077
+ isRequired: true;
1078
+ options: undefined;
1079
+ };
1080
+ /** . */
1081
+ 'name': {
1082
+ type: 'text';
1007
1083
  isRequired: true;
1008
1084
  options: undefined;
1009
1085
  };
1010
1086
  };
1011
1087
  }
1012
- interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
1088
+ interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1013
1089
  }
1014
1090
  }
1015
1091
  namespace SpruceSchemas.Files.v2022_05_13 {
1016
- interface GetSettingsStatusEmitTargetAndPayload {
1092
+ interface UploadEmitTargetAndPayload {
1017
1093
  /** Source. */
1018
1094
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1019
- 'target': SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTarget;
1095
+ 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1096
+ 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1020
1097
  }
1021
- interface GetSettingsStatusEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1022
- id: 'getSettingsStatusEmitTargetAndPayload';
1098
+ interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1099
+ id: 'uploadEmitTargetAndPayload';
1023
1100
  version: 'v2022_05_13';
1024
1101
  namespace: 'Files';
1025
1102
  name: '';
@@ -1034,36 +1111,44 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1034
1111
  };
1035
1112
  /** . */
1036
1113
  'target': {
1114
+ type: 'schema';
1115
+ options: {
1116
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1117
+ };
1118
+ };
1119
+ /** . */
1120
+ 'payload': {
1037
1121
  type: 'schema';
1038
1122
  isRequired: true;
1039
1123
  options: {
1040
- schema: SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema;
1124
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1041
1125
  };
1042
1126
  };
1043
1127
  };
1044
1128
  }
1045
- interface GetSettingsStatusEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetAndPayloadSchema> {
1129
+ interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1046
1130
  }
1047
1131
  }
1048
1132
  namespace SpruceSchemas.Files.v2022_05_13 {
1049
- interface GetSettingsStatusResponsePayload {
1050
- 'didSupplyS3Creds': boolean;
1133
+ interface GetUploadEndpointResponsePayload {
1134
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1135
+ 'restEndpointUrl'?: string | undefined | null;
1051
1136
  }
1052
- interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
1053
- id: 'getSettingsStatusResponsePayload';
1137
+ interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
1138
+ id: 'getUploadEndpointResponsePayload';
1054
1139
  version: 'v2022_05_13';
1055
1140
  namespace: 'Files';
1056
1141
  name: '';
1057
1142
  fields: {
1058
- /** . */
1059
- 'didSupplyS3Creds': {
1060
- type: 'boolean';
1061
- isRequired: true;
1143
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1144
+ 'restEndpointUrl': {
1145
+ type: 'text';
1146
+ hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
1062
1147
  options: undefined;
1063
1148
  };
1064
1149
  };
1065
1150
  }
1066
- interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
1151
+ interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
1067
1152
  }
1068
1153
  }
1069
1154
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -1108,6 +1193,29 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1108
1193
  interface UploadedFileEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadedFileSchema> {
1109
1194
  }
1110
1195
  }
1196
+ namespace SpruceSchemas.Files.v2022_05_13 {
1197
+ interface UploadResponsePayload {
1198
+ 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1199
+ }
1200
+ interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1201
+ id: 'uploadResponsePayload';
1202
+ version: 'v2022_05_13';
1203
+ namespace: 'Files';
1204
+ name: '';
1205
+ fields: {
1206
+ /** . */
1207
+ 'file': {
1208
+ type: 'schema';
1209
+ isRequired: true;
1210
+ options: {
1211
+ schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1212
+ };
1213
+ };
1214
+ };
1215
+ }
1216
+ interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1217
+ }
1218
+ }
1111
1219
  namespace SpruceSchemas.Files.v2022_05_13 {
1112
1220
  interface SettingsTarget {
1113
1221
  'organizationId': string;
@@ -1133,15 +1241,15 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1133
1241
  interface Settings {
1134
1242
  'id': string;
1135
1243
  /** AWS Access Key ID. */
1136
- 'awsAccessKeyId'?: string | undefined | null;
1244
+ 'awsAccessKeyId': string;
1137
1245
  /** AWS Secret Access Key. */
1138
- 'awsSecretAccessKey'?: string | undefined | null;
1246
+ 'awsSecretAccessKey': string;
1139
1247
  /** AWS S3 Bucket. */
1140
- 'awsS3Bucket'?: string | undefined | null;
1248
+ 'awsS3Bucket': string;
1141
1249
  /** Local Upload Directory. */
1142
- 'localUploadDir'?: string | undefined | null;
1250
+ 'localUploadDir': string;
1143
1251
  /** File Host URL. */
1144
- 'fileHostUrl'?: string | undefined | null;
1252
+ 'fileHostUrl': string;
1145
1253
  'target'?: SpruceSchemas.Files.v2022_05_13.SettingsTarget | undefined | null;
1146
1254
  }
1147
1255
  interface SettingsSchema extends SpruceSchema.Schema {
@@ -1160,30 +1268,35 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1160
1268
  'awsAccessKeyId': {
1161
1269
  label: 'AWS Access Key ID';
1162
1270
  type: 'text';
1271
+ isRequired: true;
1163
1272
  options: undefined;
1164
1273
  };
1165
1274
  /** AWS Secret Access Key. */
1166
1275
  'awsSecretAccessKey': {
1167
1276
  label: 'AWS Secret Access Key';
1168
1277
  type: 'text';
1278
+ isRequired: true;
1169
1279
  options: undefined;
1170
1280
  };
1171
1281
  /** AWS S3 Bucket. */
1172
1282
  'awsS3Bucket': {
1173
1283
  label: 'AWS S3 Bucket';
1174
1284
  type: 'text';
1285
+ isRequired: true;
1175
1286
  options: undefined;
1176
1287
  };
1177
1288
  /** Local Upload Directory. */
1178
1289
  'localUploadDir': {
1179
1290
  label: 'Local Upload Directory';
1180
1291
  type: 'text';
1292
+ isRequired: true;
1181
1293
  options: undefined;
1182
1294
  };
1183
1295
  /** File Host URL. */
1184
1296
  'fileHostUrl': {
1185
1297
  label: 'File Host URL';
1186
1298
  type: 'text';
1299
+ isRequired: true;
1187
1300
  options: undefined;
1188
1301
  };
1189
1302
  /** . */
package/build/esm/uploading/LocalUploadStrategy.d.ts CHANGED
@@ -9,10 +9,12 @@ export default class LocalUploadStrategy implements UploadStrategy {
9
9
  localUploadDir: {
10
10
  label: string;
11
11
  type: "text";
12
+ isRequired: true;
12
13
  };
13
14
  fileHostUrl: {
14
15
  label: string;
15
16
  type: "text";
17
+ isRequired: true;
16
18
  };
17
19
  };
18
20
  };