@happyvertical/smrt-social 0.57.36 → 0.57.38

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.
@@ -2,7 +2,7 @@
2
2
  "version": "1.0.0",
3
3
  "timestamp": 0,
4
4
  "packageName": "@happyvertical/smrt-social",
5
- "packageVersion": "0.57.36",
5
+ "packageVersion": "0.57.38",
6
6
  "objects": {
7
7
  "@happyvertical/smrt-social:OAuthState": {
8
8
  "name": "oauthstate",
@@ -311,12 +311,20 @@
311
311
  "name": {
312
312
  "type": "text",
313
313
  "required": false,
314
- "default": ""
314
+ "default": "",
315
+ "description": "A name you will recognise this account by.",
316
+ "_meta": {
317
+ "description": "A name you will recognise this account by."
318
+ }
315
319
  },
316
320
  "platform": {
317
321
  "type": "text",
318
322
  "required": false,
319
323
  "default": "youtube",
324
+ "description": "Which platform it is on: YouTube, X, Threads or Bluesky.",
325
+ "_meta": {
326
+ "description": "Which platform it is on: YouTube, X, Threads or Bluesky."
327
+ },
320
328
  "enum": [
321
329
  "youtube",
322
330
  "threads",
@@ -331,11 +339,19 @@
331
339
  },
332
340
  "platformUsername": {
333
341
  "type": "text",
334
- "required": false
342
+ "required": false,
343
+ "description": "The username or handle you post under.",
344
+ "_meta": {
345
+ "description": "The username or handle you post under."
346
+ }
335
347
  },
336
348
  "platformUrl": {
337
349
  "type": "text",
338
- "required": false
350
+ "required": false,
351
+ "description": "The web address of your profile on the platform.",
352
+ "_meta": {
353
+ "description": "The web address of your profile on the platform."
354
+ }
339
355
  },
340
356
  "accessToken": {
341
357
  "type": "text",
@@ -364,12 +380,20 @@
364
380
  "isActive": {
365
381
  "type": "boolean",
366
382
  "required": false,
367
- "default": true
383
+ "default": true,
384
+ "description": "Whether posts can still go out from this account.",
385
+ "_meta": {
386
+ "description": "Whether posts can still go out from this account."
387
+ }
368
388
  },
369
389
  "defaultHashtags": {
370
390
  "type": "json",
371
391
  "required": false,
372
- "default": []
392
+ "default": [],
393
+ "description": "Hashtags added to every post from this account.",
394
+ "_meta": {
395
+ "description": "Hashtags added to every post from this account."
396
+ }
373
397
  },
374
398
  "scopes": {
375
399
  "type": "json",
@@ -385,6 +409,10 @@
385
409
  "type": "text",
386
410
  "required": false,
387
411
  "default": "description",
412
+ "description": "Where a shared link goes: in the text, as a reply, or left out.",
413
+ "_meta": {
414
+ "description": "Where a shared link goes: in the text, as a reply, or left out."
415
+ },
388
416
  "enum": [
389
417
  "description",
390
418
  "inline",
@@ -413,6 +441,10 @@
413
441
  "type": "text",
414
442
  "required": false,
415
443
  "default": "connected",
444
+ "description": "Whether the account is connected, or needs signing in again.",
445
+ "_meta": {
446
+ "description": "Whether the account is connected, or needs signing in again."
447
+ },
416
448
  "enum": [
417
449
  "connected",
418
450
  "disconnected",
@@ -700,13 +732,19 @@
700
732
  "socialPostId": {
701
733
  "type": "foreignKey",
702
734
  "required": false,
703
- "related": "SocialPost"
735
+ "related": "SocialPost",
736
+ "description": "The post these numbers are for.",
737
+ "_meta": {
738
+ "description": "The post these numbers are for."
739
+ }
704
740
  },
705
741
  "platform": {
706
742
  "type": "text",
707
743
  "required": true,
744
+ "description": "The platform that reported the numbers.",
708
745
  "_meta": {
709
- "required": true
746
+ "required": true,
747
+ "description": "The platform that reported the numbers."
710
748
  },
711
749
  "enum": [
712
750
  "youtube",
@@ -718,7 +756,11 @@
718
756
  },
719
757
  "analytics": {
720
758
  "type": "json",
721
- "required": false
759
+ "required": false,
760
+ "description": "The views, likes, comments, shares and clicks the platform reported.",
761
+ "_meta": {
762
+ "description": "The views, likes, comments, shares and clicks the platform reported."
763
+ }
722
764
  },
723
765
  "raw": {
724
766
  "type": "json",
@@ -729,7 +771,11 @@
729
771
  },
730
772
  "capturedAt": {
731
773
  "type": "datetime",
732
- "required": false
774
+ "required": false,
775
+ "description": "When these numbers were taken from the platform.",
776
+ "_meta": {
777
+ "description": "When these numbers were taken from the platform."
778
+ }
733
779
  }
734
780
  },
735
781
  "methods": {},
@@ -914,7 +960,11 @@
914
960
  "socialAccountId": {
915
961
  "type": "foreignKey",
916
962
  "required": false,
917
- "related": "SocialAccount"
963
+ "related": "SocialAccount",
964
+ "description": "The connected account this post goes out from.",
965
+ "_meta": {
966
+ "description": "The connected account this post goes out from."
967
+ }
918
968
  },
919
969
  "createdByUserId": {
920
970
  "type": "crossPackageRef",
@@ -935,6 +985,10 @@
935
985
  "type": "text",
936
986
  "required": false,
937
987
  "default": "text",
988
+ "description": "What kind of post it is: text, link, image or video.",
989
+ "_meta": {
990
+ "description": "What kind of post it is: text, link, image or video."
991
+ },
938
992
  "enum": [
939
993
  "text",
940
994
  "link",
@@ -948,21 +1002,37 @@
948
1002
  },
949
1003
  "title": {
950
1004
  "type": "text",
951
- "required": false
1005
+ "required": false,
1006
+ "description": "A title, for platforms that show one.",
1007
+ "_meta": {
1008
+ "description": "A title, for platforms that show one."
1009
+ }
952
1010
  },
953
1011
  "description": {
954
1012
  "type": "text",
955
1013
  "required": false,
956
- "default": ""
1014
+ "default": "",
1015
+ "description": "The words of the post.",
1016
+ "_meta": {
1017
+ "description": "The words of the post."
1018
+ }
957
1019
  },
958
1020
  "hashtags": {
959
1021
  "type": "json",
960
1022
  "required": false,
961
- "default": []
1023
+ "default": [],
1024
+ "description": "Hashtags added to the end of the post.",
1025
+ "_meta": {
1026
+ "description": "Hashtags added to the end of the post."
1027
+ }
962
1028
  },
963
1029
  "linkUrl": {
964
1030
  "type": "text",
965
- "required": false
1031
+ "required": false,
1032
+ "description": "A web address to share with the post.",
1033
+ "_meta": {
1034
+ "description": "A web address to share with the post."
1035
+ }
966
1036
  },
967
1037
  "platformPostId": {
968
1038
  "type": "text",
@@ -970,20 +1040,36 @@
970
1040
  },
971
1041
  "platformUrl": {
972
1042
  "type": "text",
973
- "required": false
1043
+ "required": false,
1044
+ "description": "Where the post can be seen on the platform, once it is out.",
1045
+ "_meta": {
1046
+ "description": "Where the post can be seen on the platform, once it is out."
1047
+ }
974
1048
  },
975
1049
  "scheduledAt": {
976
1050
  "type": "datetime",
977
- "required": false
1051
+ "required": false,
1052
+ "description": "The date and time you have in mind for putting the post out. Only a note of the plan: publishing is a separate step your application has to run.",
1053
+ "_meta": {
1054
+ "description": "The date and time you have in mind for putting the post out. Only a note of the plan: publishing is a separate step your application has to run."
1055
+ }
978
1056
  },
979
1057
  "publishedAt": {
980
1058
  "type": "datetime",
981
- "required": false
1059
+ "required": false,
1060
+ "description": "When the post actually went out.",
1061
+ "_meta": {
1062
+ "description": "When the post actually went out."
1063
+ }
982
1064
  },
983
1065
  "status": {
984
1066
  "type": "text",
985
1067
  "required": false,
986
1068
  "default": "draft",
1069
+ "description": "Where the post stands: draft, waiting to go out, published or failed.",
1070
+ "_meta": {
1071
+ "description": "Where the post stands: draft, waiting to go out, published or failed."
1072
+ },
987
1073
  "enum": [
988
1074
  "draft",
989
1075
  "pending_approval",
@@ -2181,6 +2267,262 @@
2181
2267
  }
2182
2268
  },
2183
2269
  "moduleType": "smrt",
2270
+ "recipes": [
2271
+ {
2272
+ "id": "social.posts",
2273
+ "className": "SocialPostsRecipe",
2274
+ "label": "Social",
2275
+ "summary": "Write posts for your YouTube, X, Threads and Bluesky accounts, plan when they go out and see how each one did.",
2276
+ "synonyms": [
2277
+ "social media",
2278
+ "social posts",
2279
+ "social accounts",
2280
+ "youtube",
2281
+ "bluesky",
2282
+ "threads",
2283
+ "tweets",
2284
+ "post results"
2285
+ ],
2286
+ "models": [
2287
+ "@happyvertical/smrt-social:SocialPost",
2288
+ "@happyvertical/smrt-social:SocialAccount",
2289
+ "@happyvertical/smrt-social:SocialPostAnalyticsSnapshot"
2290
+ ],
2291
+ "nav": [
2292
+ {
2293
+ "label": "Posts",
2294
+ "model": "@happyvertical/smrt-social:SocialPost",
2295
+ "icon": "fileText",
2296
+ "description": "What you have written for each account and where it stands.",
2297
+ "noun": "post"
2298
+ },
2299
+ {
2300
+ "label": "Connected accounts",
2301
+ "model": "@happyvertical/smrt-social:SocialAccount",
2302
+ "icon": "users",
2303
+ "description": "The social accounts you can post to, and their settings.",
2304
+ "noun": "account"
2305
+ }
2306
+ ],
2307
+ "requires": [],
2308
+ "section": {
2309
+ "id": "publish",
2310
+ "label": "Publish",
2311
+ "icon": "fileText",
2312
+ "description": "What you write, record and put out."
2313
+ },
2314
+ "options": {
2315
+ "@happyvertical/smrt-social:SocialPost": {
2316
+ "fields": {
2317
+ "socialAccountId": {
2318
+ "label": "Account",
2319
+ "order": 1
2320
+ },
2321
+ "title": {
2322
+ "order": 2
2323
+ },
2324
+ "description": {
2325
+ "label": "Text",
2326
+ "order": 3
2327
+ },
2328
+ "hashtags": {
2329
+ "order": 4
2330
+ },
2331
+ "linkUrl": {
2332
+ "label": "Link",
2333
+ "order": 5
2334
+ },
2335
+ "postType": {
2336
+ "label": "Kind of post",
2337
+ "order": 6
2338
+ },
2339
+ "scheduledAt": {
2340
+ "label": "Planned for",
2341
+ "order": 7
2342
+ },
2343
+ "status": {
2344
+ "locked": true,
2345
+ "order": 8
2346
+ },
2347
+ "publishedAt": {
2348
+ "label": "Published on",
2349
+ "locked": true,
2350
+ "order": 9
2351
+ },
2352
+ "platformUrl": {
2353
+ "label": "Link to the post",
2354
+ "locked": true,
2355
+ "order": 10
2356
+ },
2357
+ "videoContentId": {
2358
+ "label": "Video",
2359
+ "visibility": "advanced"
2360
+ },
2361
+ "contentId": {
2362
+ "label": "Content",
2363
+ "visibility": "advanced"
2364
+ },
2365
+ "mediaUrl": {
2366
+ "label": "Media link",
2367
+ "visibility": "advanced"
2368
+ },
2369
+ "errorMessage": {
2370
+ "label": "What went wrong",
2371
+ "visibility": "advanced"
2372
+ },
2373
+ "analyticsLastSyncedAt": {
2374
+ "label": "Results last updated",
2375
+ "visibility": "advanced"
2376
+ },
2377
+ "tenantId": {
2378
+ "visibility": "hidden"
2379
+ },
2380
+ "createdByUserId": {
2381
+ "visibility": "hidden"
2382
+ },
2383
+ "platformPostId": {
2384
+ "visibility": "hidden"
2385
+ },
2386
+ "analytics": {
2387
+ "visibility": "hidden"
2388
+ }
2389
+ }
2390
+ },
2391
+ "@happyvertical/smrt-social:SocialAccount": {
2392
+ "fields": {
2393
+ "name": {
2394
+ "order": 1
2395
+ },
2396
+ "platform": {
2397
+ "order": 2
2398
+ },
2399
+ "platformUsername": {
2400
+ "label": "Username",
2401
+ "order": 3
2402
+ },
2403
+ "platformUrl": {
2404
+ "label": "Profile link",
2405
+ "order": 4
2406
+ },
2407
+ "status": {
2408
+ "locked": true,
2409
+ "order": 5
2410
+ },
2411
+ "isActive": {
2412
+ "label": "In use",
2413
+ "order": 6
2414
+ },
2415
+ "defaultHashtags": {
2416
+ "order": 7
2417
+ },
2418
+ "linkBehavior": {
2419
+ "label": "Where links go",
2420
+ "order": 8
2421
+ },
2422
+ "publishMode": {
2423
+ "label": "Publishing mode",
2424
+ "visibility": "advanced"
2425
+ },
2426
+ "publicPublishingAllowed": {
2427
+ "label": "Allow public posts",
2428
+ "visibility": "advanced"
2429
+ },
2430
+ "platformUserId": {
2431
+ "visibility": "advanced"
2432
+ },
2433
+ "tokenExpiresAt": {
2434
+ "label": "Connection expires",
2435
+ "visibility": "advanced"
2436
+ },
2437
+ "scopes": {
2438
+ "label": "Permissions granted",
2439
+ "visibility": "advanced"
2440
+ },
2441
+ "missingPermissions": {
2442
+ "visibility": "advanced"
2443
+ },
2444
+ "errorMessage": {
2445
+ "label": "What went wrong",
2446
+ "visibility": "advanced"
2447
+ },
2448
+ "tenantId": {
2449
+ "visibility": "hidden"
2450
+ },
2451
+ "accessToken": {
2452
+ "visibility": "hidden"
2453
+ },
2454
+ "refreshToken": {
2455
+ "visibility": "hidden"
2456
+ },
2457
+ "credentialSecretId": {
2458
+ "visibility": "hidden"
2459
+ },
2460
+ "accessTokenSecretName": {
2461
+ "visibility": "hidden"
2462
+ },
2463
+ "refreshTokenSecretName": {
2464
+ "visibility": "hidden"
2465
+ }
2466
+ }
2467
+ },
2468
+ "@happyvertical/smrt-social:SocialPostAnalyticsSnapshot": {
2469
+ "fields": {
2470
+ "socialPostId": {
2471
+ "label": "Post",
2472
+ "order": 1
2473
+ },
2474
+ "platform": {
2475
+ "order": 2
2476
+ },
2477
+ "capturedAt": {
2478
+ "label": "Measured on",
2479
+ "order": 3
2480
+ },
2481
+ "analytics": {
2482
+ "label": "Numbers",
2483
+ "order": 4
2484
+ },
2485
+ "tenantId": {
2486
+ "visibility": "hidden"
2487
+ },
2488
+ "raw": {
2489
+ "visibility": "hidden"
2490
+ }
2491
+ }
2492
+ }
2493
+ },
2494
+ "help": {
2495
+ "markdown": "## Overview\n\nSocial is where you write what you want to put out on YouTube, X, Threads and\nBluesky. Each post is written for one connected account, with its text,\nhashtags and an optional link, and can carry the date you plan to put it out.\nYour app does the publishing; once a post is out, the platform's numbers for it\narrive here as post results.\n\n## Tasks\n\n### Connect an account\n\n1. Open the connected accounts and choose **New**.\n2. Give it a **{field:SocialAccount.name}** you will recognise, such as \"Acme Corp on Bluesky\".\n3. Pick the **{field:SocialAccount.platform}** and type the **{field:SocialAccount.platformUsername}** you post under.\n4. Add any **{field:SocialAccount.defaultHashtags}** you want on every post from this account.\n5. Save. Signing in to the platform itself happens from your app, not in this form; the **{field:SocialAccount.status}** shows whether the account is connected.\n\n### Write a post\n\n1. Open the posts and choose **New**.\n2. Pick the **{field:SocialPost.socialAccountId}** it is for.\n3. Write the **{field:SocialPost.description}** and add any **{field:SocialPost.hashtags}**.\n4. Give it a **{field:SocialPost.title}** if the platform shows one, and a **{field:SocialPost.linkUrl}** if you are sharing a page.\n5. Save. It stays a draft until your app puts it out.\n\n### Note when a post should go out\n\n1. Open the post and set **{field:SocialPost.scheduledAt}** to the date and time you have in mind.\n2. Save. This only records the plan on the post. Nothing here publishes it: a post goes out only when your application's own publishing step approves it and sends it at that time, so check with whoever set up your app that this step is in place.\n\n### See where a post stands\n\nOpen the post. Its **{field:SocialPost.status}** shows whether it is a draft,\nwaiting to go out, published or failed. Once it is out, **{field:SocialPost.publishedAt}**\nand the **{field:SocialPost.platformUrl}** are filled in.\n\n### Change or remove a post\n\n1. Open the post and change what you need, then save.\n2. To remove it, open the post and choose **Delete**.\n\n### See how a post did\n\nPost results are written by the platform sync, not by hand; you can only read\nthem here.\n\n1. Open the post and look at its results, listed under the post.\n2. Each result names the **{field:SocialPostAnalyticsSnapshot.socialPostId}** it belongs to and the **{field:SocialPostAnalyticsSnapshot.platform}** it ran on.\n3. Each result shows the **{field:SocialPostAnalyticsSnapshot.analytics}** the platform reported and when they were **{field:SocialPostAnalyticsSnapshot.capturedAt}**, so the newest one is the latest count.\n\n### Stop using an account\n\n1. Open the account and untick **{field:SocialAccount.isActive}**, then save. Its posts stay, but nothing new goes out from it.\n2. To remove it entirely, open the account and choose **Delete**.\n",
2496
+ "fieldRefs": [
2497
+ "SocialAccount.defaultHashtags",
2498
+ "SocialAccount.isActive",
2499
+ "SocialAccount.name",
2500
+ "SocialAccount.platform",
2501
+ "SocialAccount.platformUsername",
2502
+ "SocialAccount.status",
2503
+ "SocialPost.description",
2504
+ "SocialPost.hashtags",
2505
+ "SocialPost.linkUrl",
2506
+ "SocialPost.platformUrl",
2507
+ "SocialPost.publishedAt",
2508
+ "SocialPost.scheduledAt",
2509
+ "SocialPost.socialAccountId",
2510
+ "SocialPost.status",
2511
+ "SocialPost.title",
2512
+ "SocialPostAnalyticsSnapshot.analytics",
2513
+ "SocialPostAnalyticsSnapshot.capturedAt",
2514
+ "SocialPostAnalyticsSnapshot.platform",
2515
+ "SocialPostAnalyticsSnapshot.socialPostId"
2516
+ ]
2517
+ },
2518
+ "demo": {
2519
+ "mode": "server",
2520
+ "reasons": [
2521
+ "Needs a server because its package does not build for a browser: node:crypto; and its package depends on @happyvertical/smrt-agents, @happyvertical/smrt-chat, @happyvertical/smrt-content, @happyvertical/smrt-images, @happyvertical/smrt-jobs, @happyvertical/smrt-profiles, @happyvertical/smrt-reports, @happyvertical/smrt-secrets, @happyvertical/smrt-tenancy, @happyvertical/smrt-users, @happyvertical/smrt-video, @happyvertical/smrt-voice, which do not build for a browser (#3615, #3617, #3624, #3625, #3626, #3627, #3628)."
2522
+ ]
2523
+ }
2524
+ }
2525
+ ],
2184
2526
  "smrtDependencies": [
2185
2527
  "@happyvertical/smrt-content",
2186
2528
  "@happyvertical/smrt-core",