@devvit/public-api 0.10.19-next-2024-04-10-2178a091f.0 → 0.10.19-next-2024-04-10-8ca84d48f.0

package/apis/ui/helpers/getFormValues.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getFormValues.d.ts","sourceRoot":"","sources":["../../../../src/apis/ui/helpers/getFormValues.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGrD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAEpD,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,cAAc,GACpB,SAAS,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,GAAG,OAAO,CAelD;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;CAAE,GAAG,IAAI,CAK9E"}
+{"version":3,"file":"getFormValues.d.ts","sourceRoot":"","sources":["../../../../src/apis/ui/helpers/getFormValues.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGrD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAEpD,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,cAAc,GACpB,SAAS,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,GAAG,OAAO,CAkBlD;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;CAAE,GAAG,IAAI,CAK9E"}

package/apis/ui/helpers/getFormValues.js

@@ -3,6 +3,9 @@ export function flattenFormFieldValue(value) {
     switch (value.fieldType) {
         case FormFieldType.STRING:
             return value.stringValue;
+        case FormFieldType.IMAGE:
+            // the string value is the URL
+            return value.stringValue;
         case FormFieldType.PARAGRAPH:
             return value.stringValue;
         case FormFieldType.NUMBER:

package/apis/ui/helpers/transformForm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transformForm.d.ts","sourceRoot":"","sources":["../../../../src/apis/ui/helpers/transformForm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,cAAc,EAAiB,MAAM,gBAAgB,CAAC;AAC5E,OAAO,KAAK,EAEV,SAAS,EAMV,MAAM,wBAAwB,CAAC;AAEhC,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,SAAS,EAAE,GAAG,cAAc,EAAE,CAmBzE"}
+{"version":3,"file":"transformForm.d.ts","sourceRoot":"","sources":["../../../../src/apis/ui/helpers/transformForm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,cAAc,EAAiB,MAAM,gBAAgB,CAAC;AAC5E,OAAO,KAAK,EAEV,SAAS,EAOV,MAAM,wBAAwB,CAAC;AAEhC,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,SAAS,EAAE,GAAG,cAAc,EAAE,CAqBzE"}

package/apis/ui/helpers/transformForm.js

@@ -4,6 +4,8 @@ export function transformFormFields(fields) {
         switch (field.type) {
             case 'string':
                 return transformStringField(field);
+            case 'image':
+                return transformImageField(field);
             case 'paragraph':
                 return transformParagraphField(field);
             case 'number':
@@ -39,6 +41,16 @@ function transformStringField(field) {
         isSecret: field.isSecret,
     });
 }
+function transformImageField(field) {
+    return FormFieldProto.fromPartial({
+        disabled: field.disabled,
+        fieldId: field.name,
+        fieldType: FormFieldType.IMAGE,
+        helpText: field.helpText,
+        label: field.label,
+        required: field.required,
+    });
+}
 function transformParagraphField(field) {
     return FormFieldProto.fromPartial({
         defaultValue: {

package/meta.json

@@ -7672,7 +7672,7 @@
       "format": "esm"
     },
     "../protos/dist/types/devvit/ui/form_builder/v1alpha/type.js": {
-      "bytes": 2341,
+      "bytes": 2604,
       "imports": [],
       "format": "esm"
     },
@@ -8123,7 +8123,7 @@
       "format": "esm"
     },
     "../protos/dist/types/devvit/dev_portal/app_version/info/app_version_info.js": {
-      "bytes": 17554,
+      "bytes": 17755,
       "imports": [
         {
           "path": "../../node_modules/protobufjs/minimal.js",
@@ -10380,27 +10380,6 @@
       ],
       "format": "esm"
     },
-    "../protos/dist/types/devvit/reddit/post_guidance/v1alpha/post_guidance.js": {
-      "bytes": 37319,
-      "imports": [
-        {
-          "path": "../../node_modules/protobufjs/minimal.js",
-          "kind": "import-statement",
-          "original": "protobufjs/minimal.js"
-        },
-        {
-          "path": "../protos/dist/types/google/protobuf/wrappers.js",
-          "kind": "import-statement",
-          "original": "../../../../google/protobuf/wrappers.js"
-        },
-        {
-          "path": "../protos/dist/types/typeRegistry.js",
-          "kind": "import-statement",
-          "original": "../../../../typeRegistry.js"
-        }
-      ],
-      "format": "esm"
-    },
     "../protos/dist/types/devvit/reddit/custom_post/v1alpha/custom_post.js": {
       "bytes": 11096,
       "imports": [
@@ -10437,6 +10416,27 @@
       ],
       "format": "esm"
     },
+    "../protos/dist/types/devvit/reddit/post_guidance/v1alpha/post_guidance.js": {
+      "bytes": 37319,
+      "imports": [
+        {
+          "path": "../../node_modules/protobufjs/minimal.js",
+          "kind": "import-statement",
+          "original": "protobufjs/minimal.js"
+        },
+        {
+          "path": "../protos/dist/types/google/protobuf/wrappers.js",
+          "kind": "import-statement",
+          "original": "../../../../google/protobuf/wrappers.js"
+        },
+        {
+          "path": "../protos/dist/types/typeRegistry.js",
+          "kind": "import-statement",
+          "original": "../../../../typeRegistry.js"
+        }
+      ],
+      "format": "esm"
+    },
     "../protos/dist/types/devvit/reddit/custom_actions/v2alpha/custom_actions.js": {
       "bytes": 17650,
       "imports": [
@@ -12188,14 +12188,14 @@
           "original": "./types/devvit/runtime/actor/v1alpha/health.js"
         },
         {
-          "path": "../protos/dist/types/devvit/reddit/post_guidance/v1alpha/post_guidance.js",
+          "path": "../protos/dist/types/devvit/reddit/custom_post/v1alpha/custom_post.js",
           "kind": "import-statement",
-          "original": "./types/devvit/reddit/post_guidance/v1alpha/post_guidance.js"
+          "original": "./types/devvit/reddit/custom_post/v1alpha/custom_post.js"
         },
         {
-          "path": "../protos/dist/types/devvit/reddit/custom_post/v1alpha/custom_post.js",
+          "path": "../protos/dist/types/devvit/reddit/post_guidance/v1alpha/post_guidance.js",
           "kind": "import-statement",
-          "original": "./types/devvit/reddit/custom_post/v1alpha/custom_post.js"
+          "original": "./types/devvit/reddit/post_guidance/v1alpha/post_guidance.js"
         },
         {
           "path": "../protos/dist/types/devvit/reddit/custom_actions/v2alpha/custom_actions.js",
@@ -12506,7 +12506,7 @@
       "format": "esm"
     },
     "src/types/form.ts": {
-      "bytes": 4551,
+      "bytes": 4907,
       "imports": [],
       "format": "esm"
     },
@@ -12683,7 +12683,7 @@
       "format": "esm"
     },
     "src/apis/ui/helpers/transformForm.ts": {
-      "bytes": 3605,
+      "bytes": 3970,
       "imports": [
         {
           "path": "../protos/dist/index.js",
@@ -12840,7 +12840,7 @@
       "format": "esm"
     },
     "src/apis/ui/helpers/getFormValues.ts": {
-      "bytes": 970,
+      "bytes": 1069,
       "imports": [
         {
           "path": "../protos/dist/index.js",
@@ -15285,7 +15285,7 @@
           "bytesInOutput": 30111
         },
         "../protos/dist/types/devvit/ui/form_builder/v1alpha/type.js": {
-          "bytesInOutput": 1799
+          "bytesInOutput": 1978
         },
         "../protos/dist/types/devvit/ui/form_builder/v1alpha/value.js": {
           "bytesInOutput": 10440
@@ -15318,7 +15318,7 @@
           "bytesInOutput": 56594
         },
         "../protos/dist/types/devvit/dev_portal/app_version/info/app_version_info.js": {
-          "bytesInOutput": 16131
+          "bytesInOutput": 16297
         },
         "../protos/dist/types/devvit/dev_portal/app/categories/categories.js": {
           "bytesInOutput": 6814
@@ -15563,12 +15563,12 @@
         "../protos/dist/types/devvit/runtime/actor/v1alpha/health.js": {
           "bytesInOutput": 2636
         },
-        "../protos/dist/types/devvit/reddit/post_guidance/v1alpha/post_guidance.js": {
-          "bytesInOutput": 33544
-        },
         "../protos/dist/types/devvit/reddit/custom_post/v1alpha/custom_post.js": {
           "bytesInOutput": 8858
         },
+        "../protos/dist/types/devvit/reddit/post_guidance/v1alpha/post_guidance.js": {
+          "bytesInOutput": 33544
+        },
         "../protos/dist/types/devvit/reddit/custom_actions/v2alpha/custom_actions.js": {
           "bytesInOutput": 15063
         },
@@ -15711,7 +15711,7 @@
           "bytesInOutput": 4465
         },
         "src/apis/ui/helpers/transformForm.ts": {
-          "bytesInOutput": 3342
+          "bytesInOutput": 3682
         },
         "src/devvit/internals/helpers/extendDevvitPrototype.ts": {
           "bytesInOutput": 86
@@ -15738,7 +15738,7 @@
           "bytesInOutput": 3613
         },
         "src/apis/ui/helpers/getFormValues.ts": {
-          "bytesInOutput": 657
+          "bytesInOutput": 723
         },
         "src/devvit/internals/blocks/useForm.ts": {
           "bytesInOutput": 1389
@@ -15942,7 +15942,7 @@
           "bytesInOutput": 370
         }
       },
-      "bytes": 14493360
+      "bytes": 14496571
     }
   }
 }

package/meta.min.json

@@ -2399,7 +2399,7 @@
       "format": "esm"
     },
     "src/types/form.ts": {
-      "bytes": 4551,
+      "bytes": 4907,
       "imports": [],
       "format": "esm"
     },
@@ -2576,7 +2576,7 @@
       "format": "esm"
     },
     "src/apis/ui/helpers/transformForm.ts": {
-      "bytes": 3605,
+      "bytes": 3970,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -2733,7 +2733,7 @@
       "format": "esm"
     },
     "src/apis/ui/helpers/getFormValues.ts": {
-      "bytes": 970,
+      "bytes": 1069,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -4618,7 +4618,7 @@
       "imports": [],
       "exports": [],
       "inputs": {},
-      "bytes": 1217009
+      "bytes": 1218109
     },
     "dist/public-api.min.js": {
       "imports": [
@@ -5182,7 +5182,7 @@
           "bytesInOutput": 362
         },
         "src/apis/ui/helpers/transformForm.ts": {
-          "bytesInOutput": 1783
+          "bytesInOutput": 1956
         },
         "src/devvit/internals/helpers/extendDevvitPrototype.ts": {
           "bytesInOutput": 33
@@ -5212,7 +5212,7 @@
           "bytesInOutput": 345
         },
         "src/apis/ui/helpers/getFormValues.ts": {
-          "bytesInOutput": 372
+          "bytesInOutput": 407
         },
         "src/devvit/internals/blocks/useForm.ts": {
           "bytesInOutput": 488
@@ -5407,7 +5407,7 @@
           "bytesInOutput": 178
         }
       },
-      "bytes": 260201
+      "bytes": 260409
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/public-api",
-  "version": "0.10.19-next-2024-04-10-2178a091f.0",
+  "version": "0.10.19-next-2024-04-10-8ca84d48f.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -29,9 +29,9 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.10.19-next-2024-04-10-2178a091f.0",
-    "@devvit/runtimes": "0.10.19-next-2024-04-10-2178a091f.0",
-    "@devvit/shared-types": "0.10.19-next-2024-04-10-2178a091f.0",
+    "@devvit/protos": "0.10.19-next-2024-04-10-8ca84d48f.0",
+    "@devvit/runtimes": "0.10.19-next-2024-04-10-8ca84d48f.0",
+    "@devvit/shared-types": "0.10.19-next-2024-04-10-8ca84d48f.0",
     "base64-js": "1.5.1",
     "clone-deep": "4.0.1",
     "core-js": "3.27.2",
@@ -41,7 +41,7 @@
     "@ampproject/filesize": "4.3.0",
     "@devvit/eslint-config": "0.10.18",
     "@devvit/repo-tools": "0.10.18",
-    "@devvit/tsconfig": "0.10.19-next-2024-04-10-2178a091f.0",
+    "@devvit/tsconfig": "0.10.19-next-2024-04-10-8ca84d48f.0",
     "@microsoft/api-extractor": "7.41.0",
     "@reddit/faceplate-ui": "11.1.0",
     "@types/clone-deep": "4.0.1",
@@ -63,5 +63,5 @@
     }
   },
   "source": "./src/index.ts",
-  "gitHead": "bb472fe813e8418bfeddfa4da605e5465f218222"
+  "gitHead": "9eae7e6e32b6b21f5dd0b5882d9b04f81ab65dd6"
 }

package/public-api.d.ts

@@ -1328,7 +1328,7 @@ export declare type FormDefinition = {
     onSubmit: FormOnSubmitEventHandler;
 };
 
-export declare type FormField = StringField | ParagraphField | NumberField | BooleanField | SelectField | FormFieldGroup;
+export declare type FormField = StringField | ImageField | ParagraphField | NumberField | BooleanField | SelectField | FormFieldGroup;
 
 /** A grouping of fields */
 export declare type FormFieldGroup = {
@@ -1607,6 +1607,15 @@ declare type ImageContainer<Context> = {
     animatedImage(opts: ImageOptions): Context;
 };
 
+/**
+ * Allows a user to upload an image as part of submitting the form. The string value that's
+ * given back is the URL of the image.
+ * @experimental
+ */
+export declare type ImageField = Omit<BaseField<string>, 'defaultValue'> & {
+    type: 'image';
+};
+
 /**
  * @borrows MediaOptions
  */