@planoly/planogram-config 1.0.7 → 1.1.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 (6) hide show
  1. package/dist/index.cjs +220 -2
  2. package/dist/index.d.cts +369 -4
  3. package/dist/index.d.ts +369 -4
  4. package/dist/index.js +220 -2
  5. package/package.json +1 -1
  6. package/postExperienceConfig.json +220 -2
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  // postExperienceConfig.json
2
2
  var postExperienceConfig_default = {
3
- version: "1.0.7",
3
+ version: "1.1.0",
4
4
  platforms: [
5
5
  {
6
6
  name: "tiktok",
@@ -8,6 +8,7 @@ var postExperienceConfig_default = {
8
8
  enabled: true,
9
9
  order: 3,
10
10
  isBeta: false,
11
+ hidePostTypeSelector: true,
11
12
  postTypes: [
12
13
  {
13
14
  name: "Video Post",
@@ -17,7 +18,7 @@ var postExperienceConfig_default = {
17
18
  "video/mp4",
18
19
  "video/quicktime"
19
20
  ],
20
- allowMultipleAssets: true,
21
+ allowMultipleAssets: false,
21
22
  allowedMultipleAssetMediaTypes: [],
22
23
  hasCaptions: true,
23
24
  hasTitle: false,
@@ -47,6 +48,54 @@ var postExperienceConfig_default = {
47
48
  allowedCoverPhotoTypes: [],
48
49
  allowCoverPhotoCanva: false,
49
50
  allowCoverPhotoImageCompression: false,
51
+ tiktokOptions: {
52
+ allowPrivacyLevel: false,
53
+ allowBrandedContent: true,
54
+ allowAutoAddMusic: false,
55
+ allowDisableComment: true,
56
+ autoAddMusicTooltip: "Recommended music will be automatically added to photos, you can change the post's music on TikTok after it posts"
57
+ },
58
+ brandContentOptions: [
59
+ {
60
+ name: "Not Promoting A Brand",
61
+ value: "none",
62
+ icon: "vp-icon-user"
63
+ },
64
+ {
65
+ name: "Brand Promotion",
66
+ value: "organic",
67
+ icon: "vp-icon-megaphone",
68
+ tooltip: "Enable if the content is promoting your own brand or business"
69
+ },
70
+ {
71
+ name: "Paid Partnership",
72
+ value: "brand",
73
+ icon: "vp-icon-currency-dollar-circle",
74
+ tooltip: "Enable if the content is a paid partnership to promote a third-party business."
75
+ }
76
+ ],
77
+ privacyLevelOptions: [
78
+ {
79
+ name: "Public",
80
+ value: "PUBLIC_TO_EVERYONE",
81
+ icon: "vp-icon-eye"
82
+ },
83
+ {
84
+ name: "Mutuals",
85
+ value: "MUTUAL_FOLLOW_FRIENDS",
86
+ icon: "vp-icon-users"
87
+ },
88
+ {
89
+ name: "Followers",
90
+ value: "FOLLOWER_OF_CREATOR",
91
+ icon: "vp-icon-user"
92
+ },
93
+ {
94
+ name: "Private",
95
+ value: "SELF_ONLY",
96
+ icon: "vp-icon-eye-off"
97
+ }
98
+ ],
50
99
  validations: [
51
100
  {
52
101
  type: "numberOfAssets",
@@ -115,6 +164,175 @@ var postExperienceConfig_default = {
115
164
  }
116
165
  }
117
166
  ]
167
+ },
168
+ {
169
+ name: "Photo Carousel",
170
+ allowAutoPost: true,
171
+ allowFirstComment: false,
172
+ allowedMediaTypes: [
173
+ "image/jpeg",
174
+ "image/webp"
175
+ ],
176
+ allowMultipleAssets: true,
177
+ allowedMultipleAssetMediaTypes: [
178
+ "image/jpeg",
179
+ "image/webp"
180
+ ],
181
+ hasCaptions: true,
182
+ hasTitle: true,
183
+ allowNotifySubscribers: false,
184
+ allowVisibility: false,
185
+ visibilityOptions: [],
186
+ coverPhotoSource: [],
187
+ allowHashtags: true,
188
+ allowSoundUrl: true,
189
+ allowSnipfeed: true,
190
+ allowSoundUrlForAutopost: false,
191
+ allowAddLink: false,
192
+ allowUserTagging: false,
193
+ allowProductTagging: false,
194
+ allowLocationTagging: false,
195
+ allowTagInLinkit: false,
196
+ allowASINTagging: false,
197
+ allowShareToFeed: false,
198
+ allowOptions: true,
199
+ allowCanva: false,
200
+ allowCollaboratorTagging: false,
201
+ canvaDesignType: "TiktokPhotoCarousel",
202
+ allowImageCompression: false,
203
+ allowCoverPhoto: false,
204
+ allowedCoverPhotoTypes: [],
205
+ allowCoverPhotoCanva: false,
206
+ allowCoverPhotoImageCompression: false,
207
+ tiktokOptions: {
208
+ allowPrivacyLevel: true,
209
+ allowBrandedContent: true,
210
+ allowAutoAddMusic: true,
211
+ allowDisableComment: true,
212
+ autoAddMusicTooltip: "Recommended music will be automatically added to photos, you can change the post's music on TikTok after it posts"
213
+ },
214
+ brandContentOptions: [
215
+ {
216
+ name: "Not Promoting A Brand",
217
+ value: "none",
218
+ icon: "vp-icon-user"
219
+ },
220
+ {
221
+ name: "Brand Promotion",
222
+ value: "organic",
223
+ icon: "vp-icon-megaphone",
224
+ tooltip: "Enable if the content is promoting your own brand or business"
225
+ },
226
+ {
227
+ name: "Paid Partnership",
228
+ value: "brand",
229
+ icon: "vp-icon-currency-dollar-circle",
230
+ tooltip: "Enable if the content is a paid partnership to promote a third-party business."
231
+ }
232
+ ],
233
+ privacyLevelOptions: [
234
+ {
235
+ name: "Public",
236
+ value: "PUBLIC_TO_EVERYONE",
237
+ icon: "vp-icon-eye"
238
+ },
239
+ {
240
+ name: "Mutuals",
241
+ value: "MUTUAL_FOLLOW_FRIENDS",
242
+ icon: "vp-icon-users"
243
+ },
244
+ {
245
+ name: "Followers",
246
+ value: "FOLLOWER_OF_CREATOR",
247
+ icon: "vp-icon-user"
248
+ },
249
+ {
250
+ name: "Private",
251
+ value: "SELF_ONLY",
252
+ icon: "vp-icon-eye-off"
253
+ }
254
+ ],
255
+ validations: [
256
+ {
257
+ type: "numberOfAssets",
258
+ userErrorMessage: "Media ineligible for auto-post. Upload 1 to 35 images to meet TikTok guidelines.",
259
+ errorHelpLink: "https://help.planoly.com/knowledge/auto-posting-to-tiktok-from-planoly",
260
+ parameters: {
261
+ min: 1,
262
+ max: 35
263
+ }
264
+ },
265
+ {
266
+ type: "autoPostImageSize",
267
+ userErrorMessage: "Media ineligible for auto-post. Your image size must be less than 20MB. Adjust size & re-upload to meet TikTok guidelines.",
268
+ errorHelpLink: "https://help.planoly.com/knowledge",
269
+ parameters: {
270
+ value: 20
271
+ }
272
+ },
273
+ {
274
+ type: "orientationSpecificMaxDimensions",
275
+ userErrorMessage: "Image resolution is too high. Please use a maximum of 1080x1920 for portrait or 1920x1080 for landscape.",
276
+ parameters: {
277
+ portrait: {
278
+ maxWidth: 1080,
279
+ maxHeight: 1920
280
+ },
281
+ landscape: {
282
+ maxWidth: 1920,
283
+ maxHeight: 1080
284
+ }
285
+ }
286
+ },
287
+ {
288
+ type: "futureDate",
289
+ userErrorMessage: "Media ineligible for auto-post. Please choose a date and time at least 5 minutes in the future.",
290
+ errorHelpLink: "https://help.planoly.com/knowledge/auto-posting-to-tiktok-from-planoly",
291
+ parameters: {
292
+ value: 5
293
+ }
294
+ },
295
+ {
296
+ type: "manualPostCaptionLength",
297
+ userErrorMessage: "Caption ineligible for posting. Your caption must be between 1 and 4000 characters. Adjust caption length to meet TikTok guidelines.",
298
+ errorHelpLink: "https://help.planoly.com/knowledge/auto-posting-to-tiktok-from-planoly",
299
+ parameters: {
300
+ min: 0,
301
+ max: 4e3
302
+ }
303
+ },
304
+ {
305
+ type: "autoPostCaptionLength",
306
+ userErrorMessage: "Caption ineligible for auto-post. Your caption must be between 1 and 4000 characters. Adjust caption length to meet TikTok guidelines.",
307
+ errorHelpLink: "https://help.planoly.com/knowledge/auto-posting-to-tiktok-from-planoly",
308
+ parameters: {
309
+ min: 0,
310
+ max: 4e3
311
+ }
312
+ },
313
+ {
314
+ type: "titleLength",
315
+ userErrorMessage: "Title ineligible for auto-post. Your title must be between 1 and 90 characters. Adjust title length to meet TikTok guidelines.",
316
+ errorHelpLink: "https://help.planoly.com/knowledge",
317
+ parameters: {
318
+ min: 1,
319
+ max: 90
320
+ }
321
+ },
322
+ {
323
+ type: "allowedMediaTypes",
324
+ 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.",
325
+ errorHelpLink: "https://help.planoly.com/knowledge"
326
+ },
327
+ {
328
+ type: "hashtagLimit",
329
+ userErrorMessage: "Hashtag limit exceeded. Please remove additional hashtags to continue.",
330
+ parameters: {
331
+ min: 0,
332
+ max: 5
333
+ }
334
+ }
335
+ ]
118
336
  }
119
337
  ]
120
338
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@planoly/planogram-config",
3
- "version": "1.0.7",
3
+ "version": "1.1.0",
4
4
  "description": "Centralized configuration for Planoly post experience across all platforms",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",
package/postExperienceConfig.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.0.7",
2
+ "version": "1.1.0",
3
3
  "platforms": [
4
4
  {
5
5
  "name": "tiktok",
@@ -7,6 +7,7 @@
7
7
  "enabled": true,
8
8
  "order": 3,
9
9
  "isBeta": false,
10
+ "hidePostTypeSelector": true,
10
11
  "postTypes": [
11
12
  {
12
13
  "name": "Video Post",
@@ -16,7 +17,7 @@
16
17
  "video/mp4",
17
18
  "video/quicktime"
18
19
  ],
19
- "allowMultipleAssets": true,
20
+ "allowMultipleAssets": false,
20
21
  "allowedMultipleAssetMediaTypes": [],
21
22
  "hasCaptions": true,
22
23
  "hasTitle": false,
@@ -46,6 +47,54 @@
46
47
  "allowedCoverPhotoTypes": [],
47
48
  "allowCoverPhotoCanva": false,
48
49
  "allowCoverPhotoImageCompression": false,
50
+ "tiktokOptions": {
51
+ "allowPrivacyLevel": false,
52
+ "allowBrandedContent": true,
53
+ "allowAutoAddMusic": false,
54
+ "allowDisableComment": true,
55
+ "autoAddMusicTooltip": "Recommended music will be automatically added to photos, you can change the post's music on TikTok after it posts"
56
+ },
57
+ "brandContentOptions": [
58
+ {
59
+ "name": "Not Promoting A Brand",
60
+ "value": "none",
61
+ "icon": "vp-icon-user"
62
+ },
63
+ {
64
+ "name": "Brand Promotion",
65
+ "value": "organic",
66
+ "icon": "vp-icon-megaphone",
67
+ "tooltip": "Enable if the content is promoting your own brand or business"
68
+ },
69
+ {
70
+ "name": "Paid Partnership",
71
+ "value": "brand",
72
+ "icon": "vp-icon-currency-dollar-circle",
73
+ "tooltip": "Enable if the content is a paid partnership to promote a third-party business."
74
+ }
75
+ ],
76
+ "privacyLevelOptions": [
77
+ {
78
+ "name": "Public",
79
+ "value": "PUBLIC_TO_EVERYONE",
80
+ "icon": "vp-icon-eye"
81
+ },
82
+ {
83
+ "name": "Mutuals",
84
+ "value": "MUTUAL_FOLLOW_FRIENDS",
85
+ "icon": "vp-icon-users"
86
+ },
87
+ {
88
+ "name": "Followers",
89
+ "value": "FOLLOWER_OF_CREATOR",
90
+ "icon": "vp-icon-user"
91
+ },
92
+ {
93
+ "name": "Private",
94
+ "value": "SELF_ONLY",
95
+ "icon": "vp-icon-eye-off"
96
+ }
97
+ ],
49
98
  "validations": [
50
99
  {
51
100
  "type": "numberOfAssets",
@@ -114,6 +163,175 @@
114
163
  }
115
164
  }
116
165
  ]
166
+ },
167
+ {
168
+ "name": "Photo Carousel",
169
+ "allowAutoPost": true,
170
+ "allowFirstComment": false,
171
+ "allowedMediaTypes": [
172
+ "image/jpeg",
173
+ "image/webp"
174
+ ],
175
+ "allowMultipleAssets": true,
176
+ "allowedMultipleAssetMediaTypes": [
177
+ "image/jpeg",
178
+ "image/webp"
179
+ ],
180
+ "hasCaptions": true,
181
+ "hasTitle": true,
182
+ "allowNotifySubscribers": false,
183
+ "allowVisibility": false,
184
+ "visibilityOptions": [],
185
+ "coverPhotoSource": [],
186
+ "allowHashtags": true,
187
+ "allowSoundUrl": true,
188
+ "allowSnipfeed": true,
189
+ "allowSoundUrlForAutopost": false,
190
+ "allowAddLink": false,
191
+ "allowUserTagging": false,
192
+ "allowProductTagging": false,
193
+ "allowLocationTagging": false,
194
+ "allowTagInLinkit": false,
195
+ "allowASINTagging": false,
196
+ "allowShareToFeed": false,
197
+ "allowOptions": true,
198
+ "allowCanva": false,
199
+ "allowCollaboratorTagging": false,
200
+ "canvaDesignType": "TiktokPhotoCarousel",
201
+ "allowImageCompression": false,
202
+ "allowCoverPhoto": false,
203
+ "allowedCoverPhotoTypes": [],
204
+ "allowCoverPhotoCanva": false,
205
+ "allowCoverPhotoImageCompression": false,
206
+ "tiktokOptions": {
207
+ "allowPrivacyLevel": true,
208
+ "allowBrandedContent": true,
209
+ "allowAutoAddMusic": true,
210
+ "allowDisableComment": true,
211
+ "autoAddMusicTooltip": "Recommended music will be automatically added to photos, you can change the post's music on TikTok after it posts"
212
+ },
213
+ "brandContentOptions": [
214
+ {
215
+ "name": "Not Promoting A Brand",
216
+ "value": "none",
217
+ "icon": "vp-icon-user"
218
+ },
219
+ {
220
+ "name": "Brand Promotion",
221
+ "value": "organic",
222
+ "icon": "vp-icon-megaphone",
223
+ "tooltip": "Enable if the content is promoting your own brand or business"
224
+ },
225
+ {
226
+ "name": "Paid Partnership",
227
+ "value": "brand",
228
+ "icon": "vp-icon-currency-dollar-circle",
229
+ "tooltip": "Enable if the content is a paid partnership to promote a third-party business."
230
+ }
231
+ ],
232
+ "privacyLevelOptions": [
233
+ {
234
+ "name": "Public",
235
+ "value": "PUBLIC_TO_EVERYONE",
236
+ "icon": "vp-icon-eye"
237
+ },
238
+ {
239
+ "name": "Mutuals",
240
+ "value": "MUTUAL_FOLLOW_FRIENDS",
241
+ "icon": "vp-icon-users"
242
+ },
243
+ {
244
+ "name": "Followers",
245
+ "value": "FOLLOWER_OF_CREATOR",
246
+ "icon": "vp-icon-user"
247
+ },
248
+ {
249
+ "name": "Private",
250
+ "value": "SELF_ONLY",
251
+ "icon": "vp-icon-eye-off"
252
+ }
253
+ ],
254
+ "validations": [
255
+ {
256
+ "type": "numberOfAssets",
257
+ "userErrorMessage": "Media ineligible for auto-post. Upload 1 to 35 images to meet TikTok guidelines.",
258
+ "errorHelpLink": "https://help.planoly.com/knowledge/auto-posting-to-tiktok-from-planoly",
259
+ "parameters": {
260
+ "min": 1,
261
+ "max": 35
262
+ }
263
+ },
264
+ {
265
+ "type": "autoPostImageSize",
266
+ "userErrorMessage": "Media ineligible for auto-post. Your image size must be less than 20MB. Adjust size & re-upload to meet TikTok guidelines.",
267
+ "errorHelpLink": "https://help.planoly.com/knowledge",
268
+ "parameters": {
269
+ "value": 20
270
+ }
271
+ },
272
+ {
273
+ "type": "orientationSpecificMaxDimensions",
274
+ "userErrorMessage": "Image resolution is too high. Please use a maximum of 1080x1920 for portrait or 1920x1080 for landscape.",
275
+ "parameters": {
276
+ "portrait": {
277
+ "maxWidth": 1080,
278
+ "maxHeight": 1920
279
+ },
280
+ "landscape": {
281
+ "maxWidth": 1920,
282
+ "maxHeight": 1080
283
+ }
284
+ }
285
+ },
286
+ {
287
+ "type": "futureDate",
288
+ "userErrorMessage": "Media ineligible for auto-post. Please choose a date and time at least 5 minutes in the future.",
289
+ "errorHelpLink": "https://help.planoly.com/knowledge/auto-posting-to-tiktok-from-planoly",
290
+ "parameters": {
291
+ "value": 5
292
+ }
293
+ },
294
+ {
295
+ "type": "manualPostCaptionLength",
296
+ "userErrorMessage": "Caption ineligible for posting. Your caption must be between 1 and 4000 characters. Adjust caption length to meet TikTok guidelines.",
297
+ "errorHelpLink": "https://help.planoly.com/knowledge/auto-posting-to-tiktok-from-planoly",
298
+ "parameters": {
299
+ "min": 0,
300
+ "max": 4000
301
+ }
302
+ },
303
+ {
304
+ "type": "autoPostCaptionLength",
305
+ "userErrorMessage": "Caption ineligible for auto-post. Your caption must be between 1 and 4000 characters. Adjust caption length to meet TikTok guidelines.",
306
+ "errorHelpLink": "https://help.planoly.com/knowledge/auto-posting-to-tiktok-from-planoly",
307
+ "parameters": {
308
+ "min": 0,
309
+ "max": 4000
310
+ }
311
+ },
312
+ {
313
+ "type": "titleLength",
314
+ "userErrorMessage": "Title ineligible for auto-post. Your title must be between 1 and 90 characters. Adjust title length to meet TikTok guidelines.",
315
+ "errorHelpLink": "https://help.planoly.com/knowledge",
316
+ "parameters": {
317
+ "min": 1,
318
+ "max": 90
319
+ }
320
+ },
321
+ {
322
+ "type": "allowedMediaTypes",
323
+ "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.",
324
+ "errorHelpLink": "https://help.planoly.com/knowledge"
325
+ },
326
+ {
327
+ "type": "hashtagLimit",
328
+ "userErrorMessage": "Hashtag limit exceeded. Please remove additional hashtags to continue.",
329
+ "parameters": {
330
+ "min": 0,
331
+ "max": 5
332
+ }
333
+ }
334
+ ]
117
335
  }
118
336
  ]
119
337
  },