@planoly/planogram-config 1.0.7 → 1.1.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-var version = "1.0.7";
+var version = "1.1.0";
 var platforms = [
 	{
 		name: "tiktok",
@@ -6,6 +6,7 @@ var platforms = [
 		enabled: true,
 		order: 3,
 		isBeta: false,
+		hidePostTypeSelector: true,
 		postTypes: [
 			{
 				name: "Video Post",
@@ -15,7 +16,7 @@ var platforms = [
 					"video/mp4",
 					"video/quicktime"
 				],
-				allowMultipleAssets: true,
+				allowMultipleAssets: false,
 				allowedMultipleAssetMediaTypes: [
 				],
 				hasCaptions: true,
@@ -48,6 +49,54 @@ var platforms = [
 				],
 				allowCoverPhotoCanva: false,
 				allowCoverPhotoImageCompression: false,
+				tiktokOptions: {
+					allowPrivacyLevel: false,
+					allowBrandedContent: true,
+					allowAutoAddMusic: false,
+					allowDisableComment: true,
+					autoAddMusicTooltip: "Recommended music will be automatically added to photos, you can change the post's music on TikTok after it posts"
+				},
+				brandContentOptions: [
+					{
+						name: "Not Promoting A Brand",
+						value: "none",
+						icon: "vp-icon-user"
+					},
+					{
+						name: "Brand Promotion",
+						value: "organic",
+						icon: "vp-icon-megaphone",
+						tooltip: "Enable if the content is promoting your own brand or business"
+					},
+					{
+						name: "Paid Partnership",
+						value: "brand",
+						icon: "vp-icon-currency-dollar-circle",
+						tooltip: "Enable if the content is a paid partnership to promote a third-party business."
+					}
+				],
+				privacyLevelOptions: [
+					{
+						name: "Public",
+						value: "PUBLIC_TO_EVERYONE",
+						icon: "vp-icon-eye"
+					},
+					{
+						name: "Mutuals",
+						value: "MUTUAL_FOLLOW_FRIENDS",
+						icon: "vp-icon-users"
+					},
+					{
+						name: "Followers",
+						value: "FOLLOWER_OF_CREATOR",
+						icon: "vp-icon-user"
+					},
+					{
+						name: "Private",
+						value: "SELF_ONLY",
+						icon: "vp-icon-eye-off"
+					}
+				],
 				validations: [
 					{
 						type: "numberOfAssets",
@@ -116,6 +165,178 @@ var platforms = [
 						}
 					}
 				]
+			},
+			{
+				name: "Photo Carousel",
+				allowAutoPost: true,
+				allowFirstComment: false,
+				allowedMediaTypes: [
+					"image/jpeg",
+					"image/webp"
+				],
+				allowMultipleAssets: true,
+				allowedMultipleAssetMediaTypes: [
+					"image/jpeg",
+					"image/webp"
+				],
+				hasCaptions: true,
+				hasTitle: true,
+				allowNotifySubscribers: false,
+				allowVisibility: false,
+				visibilityOptions: [
+				],
+				coverPhotoSource: [
+				],
+				allowHashtags: true,
+				allowSoundUrl: true,
+				allowSnipfeed: true,
+				allowSoundUrlForAutopost: false,
+				allowAddLink: false,
+				allowUserTagging: false,
+				allowProductTagging: false,
+				allowLocationTagging: false,
+				allowTagInLinkit: false,
+				allowASINTagging: false,
+				allowShareToFeed: false,
+				allowOptions: true,
+				allowCanva: false,
+				allowCollaboratorTagging: false,
+				canvaDesignType: "TiktokPhotoCarousel",
+				allowImageCompression: false,
+				allowCoverPhoto: false,
+				allowedCoverPhotoTypes: [
+				],
+				allowCoverPhotoCanva: false,
+				allowCoverPhotoImageCompression: false,
+				tiktokOptions: {
+					allowPrivacyLevel: true,
+					allowBrandedContent: true,
+					allowAutoAddMusic: true,
+					allowDisableComment: true,
+					autoAddMusicTooltip: "Recommended music will be automatically added to photos, you can change the post's music on TikTok after it posts"
+				},
+				brandContentOptions: [
+					{
+						name: "Not Promoting A Brand",
+						value: "none",
+						icon: "vp-icon-user"
+					},
+					{
+						name: "Brand Promotion",
+						value: "organic",
+						icon: "vp-icon-megaphone",
+						tooltip: "Enable if the content is promoting your own brand or business"
+					},
+					{
+						name: "Paid Partnership",
+						value: "brand",
+						icon: "vp-icon-currency-dollar-circle",
+						tooltip: "Enable if the content is a paid partnership to promote a third-party business."
+					}
+				],
+				privacyLevelOptions: [
+					{
+						name: "Public",
+						value: "PUBLIC_TO_EVERYONE",
+						icon: "vp-icon-eye"
+					},
+					{
+						name: "Mutuals",
+						value: "MUTUAL_FOLLOW_FRIENDS",
+						icon: "vp-icon-users"
+					},
+					{
+						name: "Followers",
+						value: "FOLLOWER_OF_CREATOR",
+						icon: "vp-icon-user"
+					},
+					{
+						name: "Private",
+						value: "SELF_ONLY",
+						icon: "vp-icon-eye-off"
+					}
+				],
+				validations: [
+					{
+						type: "numberOfAssets",
+						userErrorMessage: "Media ineligible for auto-post. Upload 1 to 35 images to meet TikTok guidelines.",
+						errorHelpLink: "https://help.planoly.com/knowledge/auto-posting-to-tiktok-from-planoly",
+						parameters: {
+							min: 1,
+							max: 35
+						}
+					},
+					{
+						type: "autoPostImageSize",
+						userErrorMessage: "Media ineligible for auto-post. Your image size must be less than 20MB. Adjust size & re-upload to meet TikTok guidelines.",
+						errorHelpLink: "https://help.planoly.com/knowledge",
+						parameters: {
+							value: 20
+						}
+					},
+					{
+						type: "orientationSpecificMaxDimensions",
+						userErrorMessage: "Image resolution is too high. Please use a maximum of 1080x1920 for portrait or 1920x1080 for landscape.",
+						parameters: {
+							portrait: {
+								maxWidth: 1080,
+								maxHeight: 1920
+							},
+							landscape: {
+								maxWidth: 1920,
+								maxHeight: 1080
+							}
+						}
+					},
+					{
+						type: "futureDate",
+						userErrorMessage: "Media ineligible for auto-post. Please choose a date and time at least 5 minutes in the future.",
+						errorHelpLink: "https://help.planoly.com/knowledge/auto-posting-to-tiktok-from-planoly",
+						parameters: {
+							value: 5
+						}
+					},
+					{
+						type: "manualPostCaptionLength",
+						userErrorMessage: "Caption ineligible for posting. Your caption must be between 1 and 4000 characters. Adjust caption length to meet TikTok guidelines.",
+						errorHelpLink: "https://help.planoly.com/knowledge/auto-posting-to-tiktok-from-planoly",
+						parameters: {
+							min: 0,
+							max: 4000
+						}
+					},
+					{
+						type: "autoPostCaptionLength",
+						userErrorMessage: "Caption ineligible for auto-post. Your caption must be between 1 and 4000 characters. Adjust caption length to meet TikTok guidelines.",
+						errorHelpLink: "https://help.planoly.com/knowledge/auto-posting-to-tiktok-from-planoly",
+						parameters: {
+							min: 0,
+							max: 4000
+						}
+					},
+					{
+						type: "titleLength",
+						userErrorMessage: "Title ineligible for auto-post. Your title must be between 1 and 90 characters. Adjust title length to meet TikTok guidelines.",
+						errorHelpLink: "https://help.planoly.com/knowledge",
+						parameters: {
+							min: 1,
+							max: 90
+						}
+					},
+					{
+						type: "allowedMediaTypes",
+						userErrorMessage: "Media ineligible for posting. Image content must be uploaded in .jpeg, .jpg, or .webp format. Adjust your file type and re-upload to meet TikTok guidelines.",
+						errorHelpLink: "https://help.planoly.com/knowledge"
+					},
+					{
+						type: "hashtagLimit",
+						userErrorMessage: "Hashtag limit exceeded. Please remove additional hashtags to continue.",
+						parameters: {
+							min: 0,
+							max: 5
+						}
+					}
+				]
 			}
 		]
 	},
@@ -2285,7 +2506,8 @@ declare const postExperienceConfig: {
         enabled: boolean;
         order: number;
         isBeta: boolean;
-        postTypes: {
+        hidePostTypeSelector: boolean;
+        postTypes: ({
             name: string;
             allowAutoPost: boolean;
             allowFirstComment: boolean;
@@ -2318,6 +2540,29 @@ declare const postExperienceConfig: {
             allowedCoverPhotoTypes: never[];
             allowCoverPhotoCanva: boolean;
             allowCoverPhotoImageCompression: boolean;
+            tiktokOptions: {
+                allowPrivacyLevel: boolean;
+                allowBrandedContent: boolean;
+                allowAutoAddMusic: boolean;
+                allowDisableComment: boolean;
+                autoAddMusicTooltip: string;
+            };
+            brandContentOptions: ({
+                name: string;
+                value: string;
+                icon: string;
+                tooltip?: undefined;
+            } | {
+                name: string;
+                value: string;
+                icon: string;
+                tooltip: string;
+            })[];
+            privacyLevelOptions: {
+                name: string;
+                value: string;
+                icon: string;
+            }[];
             validations: ({
                 type: string;
                 userErrorMessage: string;
@@ -2368,7 +2613,119 @@ declare const postExperienceConfig: {
                 };
                 errorHelpLink?: undefined;
             })[];
-        }[];
+        } | {
+            name: string;
+            allowAutoPost: boolean;
+            allowFirstComment: boolean;
+            allowedMediaTypes: string[];
+            allowMultipleAssets: boolean;
+            allowedMultipleAssetMediaTypes: string[];
+            hasCaptions: boolean;
+            hasTitle: boolean;
+            allowNotifySubscribers: boolean;
+            allowVisibility: boolean;
+            visibilityOptions: never[];
+            coverPhotoSource: never[];
+            allowHashtags: boolean;
+            allowSoundUrl: boolean;
+            allowSnipfeed: boolean;
+            allowSoundUrlForAutopost: boolean;
+            allowAddLink: boolean;
+            allowUserTagging: boolean;
+            allowProductTagging: boolean;
+            allowLocationTagging: boolean;
+            allowTagInLinkit: boolean;
+            allowASINTagging: boolean;
+            allowShareToFeed: boolean;
+            allowOptions: boolean;
+            allowCanva: boolean;
+            allowCollaboratorTagging: boolean;
+            canvaDesignType: string;
+            allowImageCompression: boolean;
+            allowCoverPhoto: boolean;
+            allowedCoverPhotoTypes: never[];
+            allowCoverPhotoCanva: boolean;
+            allowCoverPhotoImageCompression: boolean;
+            tiktokOptions: {
+                allowPrivacyLevel: boolean;
+                allowBrandedContent: boolean;
+                allowAutoAddMusic: boolean;
+                allowDisableComment: boolean;
+                autoAddMusicTooltip: string;
+            };
+            brandContentOptions: ({
+                name: string;
+                value: string;
+                icon: string;
+                tooltip?: undefined;
+            } | {
+                name: string;
+                value: string;
+                icon: string;
+                tooltip: string;
+            })[];
+            privacyLevelOptions: {
+                name: string;
+                value: string;
+                icon: string;
+            }[];
+            validations: ({
+                type: string;
+                userErrorMessage: string;
+                errorHelpLink: string;
+                parameters: {
+                    min: number;
+                    max: number;
+                    value?: undefined;
+                    portrait?: undefined;
+                    landscape?: undefined;
+                };
+            } | {
+                type: string;
+                userErrorMessage: string;
+                errorHelpLink: string;
+                parameters: {
+                    value: number;
+                    min?: undefined;
+                    max?: undefined;
+                    portrait?: undefined;
+                    landscape?: undefined;
+                };
+            } | {
+                type: string;
+                userErrorMessage: string;
+                parameters: {
+                    portrait: {
+                        maxWidth: number;
+                        maxHeight: number;
+                    };
+                    landscape: {
+                        maxWidth: number;
+                        maxHeight: number;
+                    };
+                    min?: undefined;
+                    max?: undefined;
+                    value?: undefined;
+                };
+                errorHelpLink?: undefined;
+            } | {
+                type: string;
+                userErrorMessage: string;
+                errorHelpLink: string;
+                parameters?: undefined;
+            } | {
+                type: string;
+                userErrorMessage: string;
+                parameters: {
+                    min: number;
+                    max: number;
+                    value?: undefined;
+                    portrait?: undefined;
+                    landscape?: undefined;
+                };
+                errorHelpLink?: undefined;
+            })[];
+        })[];
     } | {
         name: string;
         id: number;
@@ -2691,6 +3048,7 @@ declare const postExperienceConfig: {
             })[];
             information?: undefined;
         })[];
+        hidePostTypeSelector?: undefined;
     } | {
         name: string;
         id: number;
@@ -2976,6 +3334,7 @@ declare const postExperienceConfig: {
             })[];
             information?: undefined;
         })[];
+        hidePostTypeSelector?: undefined;
     } | {
         name: string;
         id: number;
@@ -3075,6 +3434,7 @@ declare const postExperienceConfig: {
                 };
             })[];
         }[];
+        hidePostTypeSelector?: undefined;
     } | {
         name: string;
         id: number;
@@ -3190,6 +3550,7 @@ declare const postExperienceConfig: {
                 };
             })[];
         }[];
+        hidePostTypeSelector?: undefined;
     } | {
         name: string;
         id: number;
@@ -3263,6 +3624,7 @@ declare const postExperienceConfig: {
                 errorHelpLink?: undefined;
             })[];
         }[];
+        hidePostTypeSelector?: undefined;
     } | {
         name: string;
         id: number;
@@ -3341,6 +3703,7 @@ declare const postExperienceConfig: {
                 errorHelpLink?: undefined;
             })[];
         }[];
+        hidePostTypeSelector?: undefined;
     } | {
         name: string;
         id: number;
@@ -3405,6 +3768,7 @@ declare const postExperienceConfig: {
                 errorHelpLink?: undefined;
             })[];
         }[];
+        hidePostTypeSelector?: undefined;
     } | {
         name: string;
         id: number;
@@ -3524,6 +3888,7 @@ declare const postExperienceConfig: {
                 };
             })[];
         }[];
+        hidePostTypeSelector?: undefined;
     })[];
 };