@shuffl/cli 0.7.15 → 0.7.16

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.
@@ -3953,6 +3953,10 @@ export const commands = [
3953
3953
  const: 'mentorship.circles.save',
3954
3954
  type: 'string',
3955
3955
  },
3956
+ {
3957
+ const: 'mentorship.cohorts.sponsor',
3958
+ type: 'string',
3959
+ },
3956
3960
  {
3957
3961
  const: 'mentorship.feedback.save',
3958
3962
  type: 'string',
@@ -3965,10 +3969,22 @@ export const commands = [
3965
3969
  const: 'mentorship.goals.save',
3966
3970
  type: 'string',
3967
3971
  },
3972
+ {
3973
+ const: 'mentorship.invitations.answer',
3974
+ type: 'string',
3975
+ },
3976
+ {
3977
+ const: 'mentorship.invitations.send',
3978
+ type: 'string',
3979
+ },
3968
3980
  {
3969
3981
  const: 'mentorship.join',
3970
3982
  type: 'string',
3971
3983
  },
3984
+ {
3985
+ const: 'mentorship.leaders.get',
3986
+ type: 'string',
3987
+ },
3972
3988
  {
3973
3989
  const: 'mentorship.leave',
3974
3990
  type: 'string',
@@ -3977,6 +3993,10 @@ export const commands = [
3977
3993
  const: 'mentorship.members.setStatus',
3978
3994
  type: 'string',
3979
3995
  },
3996
+ {
3997
+ const: 'mentorship.mentors.candidates',
3998
+ type: 'string',
3999
+ },
3980
4000
  {
3981
4001
  const: 'mentorship.mentors.choose',
3982
4002
  type: 'string',
@@ -3985,6 +4005,10 @@ export const commands = [
3985
4005
  const: 'mentorship.mine',
3986
4006
  type: 'string',
3987
4007
  },
4008
+ {
4009
+ const: 'mentorship.pairs.approveAll',
4010
+ type: 'string',
4011
+ },
3988
4012
  {
3989
4013
  const: 'mentorship.pairs.decide',
3990
4014
  type: 'string',
@@ -3993,6 +4017,10 @@ export const commands = [
3993
4017
  const: 'mentorship.pairs.end',
3994
4018
  type: 'string',
3995
4019
  },
4020
+ {
4021
+ const: 'mentorship.pairs.nudge',
4022
+ type: 'string',
4023
+ },
3996
4024
  {
3997
4025
  const: 'mentorship.pairs.setMine',
3998
4026
  type: 'string',
@@ -4001,6 +4029,14 @@ export const commands = [
4001
4029
  const: 'mentorship.pairs.suggest',
4002
4030
  type: 'string',
4003
4031
  },
4032
+ {
4033
+ const: 'mentorship.profiles.get',
4034
+ type: 'string',
4035
+ },
4036
+ {
4037
+ const: 'mentorship.profiles.setHidden',
4038
+ type: 'string',
4039
+ },
4004
4040
  {
4005
4041
  const: 'mentorship.programs.get',
4006
4042
  type: 'string',
@@ -4037,6 +4073,10 @@ export const commands = [
4037
4073
  const: 'mentorship.settings.save',
4038
4074
  type: 'string',
4039
4075
  },
4076
+ {
4077
+ const: 'mentorship.thanks.save',
4078
+ type: 'string',
4079
+ },
4040
4080
  {
4041
4081
  const: 'network.claim',
4042
4082
  type: 'string',
@@ -9316,6 +9356,37 @@ export const commands = [
9316
9356
  scope: 'mentorship:write',
9317
9357
  summary: 'Set or move a mentorship program’s next mentor circle, a short meeting where its mentors swap what works',
9318
9358
  },
9359
+ {
9360
+ access: 'write',
9361
+ command: ['mentorship', 'cohorts', 'sponsor'],
9362
+ input: {
9363
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
9364
+ additionalProperties: false,
9365
+ properties: {
9366
+ confirm: {
9367
+ const: 'mentorship.cohorts.sponsor',
9368
+ type: 'string',
9369
+ },
9370
+ note: {
9371
+ type: ['null', 'string'],
9372
+ },
9373
+ programId: {
9374
+ type: 'string',
9375
+ },
9376
+ requestKey: {
9377
+ maxLength: 128,
9378
+ minLength: 1,
9379
+ type: 'string',
9380
+ },
9381
+ },
9382
+ required: ['note', 'programId', 'confirm', 'requestKey'],
9383
+ type: 'object',
9384
+ },
9385
+ path: ['mentorship', 'cohorts', 'sponsor'],
9386
+ permission: 'mentorship.cohorts.sponsor',
9387
+ scope: 'self:write',
9388
+ summary: 'Sponsor an upcoming mentorship cohort with a short note shown on its invite and kickoff, or take it back',
9389
+ },
9319
9390
  {
9320
9391
  access: 'write',
9321
9392
  command: ['mentorship', 'feedback', 'save'],
@@ -9427,6 +9498,102 @@ export const commands = [
9427
9498
  scope: 'self:write',
9428
9499
  summary: 'Add, rename or check off a goal in your mentorship, as the mentee',
9429
9500
  },
9501
+ {
9502
+ access: 'write',
9503
+ command: ['mentorship', 'invitations', 'answer'],
9504
+ input: {
9505
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
9506
+ additionalProperties: false,
9507
+ properties: {
9508
+ answer: {
9509
+ anyOf: [
9510
+ {
9511
+ const: 'later',
9512
+ type: 'string',
9513
+ },
9514
+ {
9515
+ const: 'not_now',
9516
+ type: 'string',
9517
+ },
9518
+ {
9519
+ const: 'yes',
9520
+ type: 'string',
9521
+ },
9522
+ ],
9523
+ },
9524
+ confirm: {
9525
+ const: 'mentorship.invitations.answer',
9526
+ type: 'string',
9527
+ },
9528
+ invitationId: {
9529
+ type: 'string',
9530
+ },
9531
+ requestKey: {
9532
+ maxLength: 128,
9533
+ minLength: 1,
9534
+ type: 'string',
9535
+ },
9536
+ },
9537
+ required: ['answer', 'invitationId', 'confirm', 'requestKey'],
9538
+ type: 'object',
9539
+ },
9540
+ path: ['mentorship', 'invitations', 'answer'],
9541
+ permission: 'mentorship.invitations.answer',
9542
+ scope: 'self:write',
9543
+ summary: 'Answer an invite to mentor: yes, not now, or ask me later',
9544
+ },
9545
+ {
9546
+ access: 'write',
9547
+ command: ['mentorship', 'invitations', 'send'],
9548
+ input: {
9549
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
9550
+ additionalProperties: false,
9551
+ properties: {
9552
+ confirm: {
9553
+ const: 'mentorship.invitations.send',
9554
+ type: 'string',
9555
+ },
9556
+ message: {
9557
+ type: 'string',
9558
+ },
9559
+ personIds: {
9560
+ items: {
9561
+ type: 'string',
9562
+ },
9563
+ type: 'array',
9564
+ },
9565
+ programId: {
9566
+ type: 'string',
9567
+ },
9568
+ requestKey: {
9569
+ maxLength: 128,
9570
+ minLength: 1,
9571
+ type: 'string',
9572
+ },
9573
+ tellManagers: {
9574
+ anyOf: [
9575
+ {
9576
+ const: false,
9577
+ type: 'boolean',
9578
+ },
9579
+ {
9580
+ const: true,
9581
+ type: 'boolean',
9582
+ },
9583
+ ],
9584
+ },
9585
+ topic: {
9586
+ type: 'string',
9587
+ },
9588
+ },
9589
+ required: ['message', 'personIds', 'programId', 'confirm', 'requestKey'],
9590
+ type: 'object',
9591
+ },
9592
+ path: ['mentorship', 'invitations', 'send'],
9593
+ permission: 'mentorship.invitations.send',
9594
+ scope: 'mentorship:write',
9595
+ summary: 'Invite up to 20 people to mentor in a program, optionally telling their managers. Nobody becomes a mentor until they say yes',
9596
+ },
9430
9597
  {
9431
9598
  access: 'write',
9432
9599
  command: ['mentorship', 'join'],
@@ -9476,6 +9643,20 @@ export const commands = [
9476
9643
  scope: 'self:write',
9477
9644
  summary: 'Join a mentorship program as a mentor or mentee, saying what you can help with or want to learn, and as a mentor how many mentees and hours you can give',
9478
9645
  },
9646
+ {
9647
+ access: 'read',
9648
+ command: ['mentorship', 'leaders', 'get'],
9649
+ input: {
9650
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
9651
+ additionalProperties: false,
9652
+ properties: {},
9653
+ type: 'object',
9654
+ },
9655
+ path: ['mentorship', 'leaders', 'get'],
9656
+ permission: 'mentorship.leaders.get',
9657
+ scope: 'self:read',
9658
+ summary: 'Mentorship across the people you lead: how many take part against the company, topics short of mentors and cohorts you can sponsor. Totals only',
9659
+ },
9479
9660
  {
9480
9661
  access: 'write',
9481
9662
  command: ['mentorship', 'leave'],
@@ -9578,6 +9759,28 @@ export const commands = [
9578
9759
  scope: 'mentorship:write',
9579
9760
  summary: 'Take someone off a mentorship program, or put them back',
9580
9761
  },
9762
+ {
9763
+ access: 'read',
9764
+ command: ['mentorship', 'mentors', 'candidates'],
9765
+ input: {
9766
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
9767
+ additionalProperties: false,
9768
+ properties: {
9769
+ programId: {
9770
+ type: 'string',
9771
+ },
9772
+ topic: {
9773
+ type: 'string',
9774
+ },
9775
+ },
9776
+ required: ['programId'],
9777
+ type: 'object',
9778
+ },
9779
+ path: ['mentorship', 'mentors', 'candidates'],
9780
+ permission: 'mentorship.mentors.candidates',
9781
+ scope: 'mentorship:read',
9782
+ summary: 'People who could mentor a topic, from their titles, tenure, who they manage and praise that mentions it, with a drafted invite',
9783
+ },
9581
9784
  {
9582
9785
  access: 'write',
9583
9786
  command: ['mentorship', 'mentors', 'choose'],
@@ -9623,6 +9826,34 @@ export const commands = [
9623
9826
  scope: 'self:read',
9624
9827
  summary: 'Your mentorship programs and pairings, with goals and check-ins',
9625
9828
  },
9829
+ {
9830
+ access: 'write',
9831
+ command: ['mentorship', 'pairs', 'approve-all'],
9832
+ input: {
9833
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
9834
+ additionalProperties: false,
9835
+ properties: {
9836
+ confirm: {
9837
+ const: 'mentorship.pairs.approveAll',
9838
+ type: 'string',
9839
+ },
9840
+ programId: {
9841
+ type: 'string',
9842
+ },
9843
+ requestKey: {
9844
+ maxLength: 128,
9845
+ minLength: 1,
9846
+ type: 'string',
9847
+ },
9848
+ },
9849
+ required: ['programId', 'confirm', 'requestKey'],
9850
+ type: 'object',
9851
+ },
9852
+ path: ['mentorship', 'pairs', 'approveAll'],
9853
+ permission: 'mentorship.pairs.approveAll',
9854
+ scope: 'mentorship:write',
9855
+ summary: 'Approve every suggested pair in a mentorship program at once. In a cohort before its start day they wait for it; otherwise each starts now',
9856
+ },
9626
9857
  {
9627
9858
  access: 'write',
9628
9859
  command: ['mentorship', 'pairs', 'decide'],
@@ -9691,6 +9922,34 @@ export const commands = [
9691
9922
  scope: 'mentorship:write',
9692
9923
  summary: 'End a mentorship pairing early',
9693
9924
  },
9925
+ {
9926
+ access: 'write',
9927
+ command: ['mentorship', 'pairs', 'nudge'],
9928
+ input: {
9929
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
9930
+ additionalProperties: false,
9931
+ properties: {
9932
+ confirm: {
9933
+ const: 'mentorship.pairs.nudge',
9934
+ type: 'string',
9935
+ },
9936
+ programId: {
9937
+ type: 'string',
9938
+ },
9939
+ requestKey: {
9940
+ maxLength: 128,
9941
+ minLength: 1,
9942
+ type: 'string',
9943
+ },
9944
+ },
9945
+ required: ['programId', 'confirm', 'requestKey'],
9946
+ type: 'object',
9947
+ },
9948
+ path: ['mentorship', 'pairs', 'nudge'],
9949
+ permission: 'mentorship.pairs.nudge',
9950
+ scope: 'mentorship:write',
9951
+ summary: 'Nudge every pair in a mentorship program that hasn’t met in three weeks to pick a time. Each pair hears it once a week at most',
9952
+ },
9694
9953
  {
9695
9954
  access: 'write',
9696
9955
  command: ['mentorship', 'pairs', 'set-mine'],
@@ -9763,6 +10022,53 @@ export const commands = [
9763
10022
  scope: 'mentorship:write',
9764
10023
  summary: 'Suggest a mentor outside their reporting line for every mentee still waiting',
9765
10024
  },
10025
+ {
10026
+ access: 'read',
10027
+ command: ['mentorship', 'profiles', 'get'],
10028
+ input: {
10029
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
10030
+ additionalProperties: false,
10031
+ properties: {
10032
+ personId: {
10033
+ type: 'string',
10034
+ },
10035
+ },
10036
+ required: ['personId'],
10037
+ type: 'object',
10038
+ },
10039
+ path: ['mentorship', 'profiles', 'get'],
10040
+ permission: 'mentorship.profiles.get',
10041
+ scope: 'users:read',
10042
+ summary: 'A person’s Mentoring section: how many people they mentored, what they offer and the thank-yous shared there',
10043
+ },
10044
+ {
10045
+ access: 'write',
10046
+ command: ['mentorship', 'profiles', 'set-hidden'],
10047
+ input: {
10048
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
10049
+ additionalProperties: false,
10050
+ properties: {
10051
+ confirm: {
10052
+ const: 'mentorship.profiles.setHidden',
10053
+ type: 'string',
10054
+ },
10055
+ hidden: {
10056
+ type: 'boolean',
10057
+ },
10058
+ requestKey: {
10059
+ maxLength: 128,
10060
+ minLength: 1,
10061
+ type: 'string',
10062
+ },
10063
+ },
10064
+ required: ['hidden', 'confirm', 'requestKey'],
10065
+ type: 'object',
10066
+ },
10067
+ path: ['mentorship', 'profiles', 'setHidden'],
10068
+ permission: 'mentorship.profiles.setHidden',
10069
+ scope: 'profile:write',
10070
+ summary: 'Hide or show the Mentoring section of your own profile',
10071
+ },
9766
10072
  {
9767
10073
  access: 'read',
9768
10074
  command: ['mentorship', 'programs', 'get'],
@@ -9806,6 +10112,26 @@ export const commands = [
9806
10112
  checkInWeeks: {
9807
10113
  type: 'number',
9808
10114
  },
10115
+ cohort: {
10116
+ anyOf: [
10117
+ {
10118
+ type: 'null',
10119
+ },
10120
+ {
10121
+ additionalProperties: false,
10122
+ properties: {
10123
+ signupClosesOn: {
10124
+ type: 'string',
10125
+ },
10126
+ startsOn: {
10127
+ type: 'string',
10128
+ },
10129
+ },
10130
+ required: ['signupClosesOn', 'startsOn'],
10131
+ type: 'object',
10132
+ },
10133
+ ],
10134
+ },
9809
10135
  confirm: {
9810
10136
  const: 'mentorship.programs.save',
9811
10137
  type: 'string',
@@ -9813,6 +10139,26 @@ export const commands = [
9813
10139
  description: {
9814
10140
  type: 'string',
9815
10141
  },
10142
+ format: {
10143
+ anyOf: [
10144
+ {
10145
+ const: 'ask_once',
10146
+ type: 'string',
10147
+ },
10148
+ {
10149
+ const: 'circle',
10150
+ type: 'string',
10151
+ },
10152
+ {
10153
+ const: 'one_to_one',
10154
+ type: 'string',
10155
+ },
10156
+ {
10157
+ const: 'reverse',
10158
+ type: 'string',
10159
+ },
10160
+ ],
10161
+ },
9816
10162
  groupId: {
9817
10163
  type: ['null', 'string'],
9818
10164
  },
@@ -9852,7 +10198,7 @@ export const commands = [
9852
10198
  path: ['mentorship', 'programs', 'save'],
9853
10199
  permission: 'mentorship.programs.save',
9854
10200
  scope: 'mentorship:write',
9855
- summary: 'Create or change a mentorship program: who can join, how long pairings last and how often pairs check in',
10201
+ summary: 'Create or change a mentorship program: who can join, its format (one to one, ask once, circles or reverse mentoring), whether it runs as a cohort, how long pairings last and how often pairs check in',
9856
10202
  },
9857
10203
  {
9858
10204
  access: 'write',
@@ -10063,6 +10409,64 @@ export const commands = [
10063
10409
  scope: 'mentorship:write',
10064
10410
  summary: 'Change what a new mentorship program starts with; existing programs keep their own terms',
10065
10411
  },
10412
+ {
10413
+ access: 'write',
10414
+ command: ['mentorship', 'thanks', 'save'],
10415
+ input: {
10416
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
10417
+ additionalProperties: false,
10418
+ properties: {
10419
+ confirm: {
10420
+ const: 'mentorship.thanks.save',
10421
+ type: 'string',
10422
+ },
10423
+ message: {
10424
+ type: 'string',
10425
+ },
10426
+ onProfile: {
10427
+ anyOf: [
10428
+ {
10429
+ const: false,
10430
+ type: 'boolean',
10431
+ },
10432
+ {
10433
+ const: true,
10434
+ type: 'boolean',
10435
+ },
10436
+ ],
10437
+ },
10438
+ pairId: {
10439
+ type: 'string',
10440
+ },
10441
+ praiseChannelId: {
10442
+ type: ['null', 'string'],
10443
+ },
10444
+ requestKey: {
10445
+ maxLength: 128,
10446
+ minLength: 1,
10447
+ type: 'string',
10448
+ },
10449
+ tellManager: {
10450
+ anyOf: [
10451
+ {
10452
+ const: false,
10453
+ type: 'boolean',
10454
+ },
10455
+ {
10456
+ const: true,
10457
+ type: 'boolean',
10458
+ },
10459
+ ],
10460
+ },
10461
+ },
10462
+ required: ['message', 'pairId', 'confirm', 'requestKey'],
10463
+ type: 'object',
10464
+ },
10465
+ path: ['mentorship', 'thanks', 'save'],
10466
+ permission: 'mentorship.thanks.save',
10467
+ scope: 'self:write',
10468
+ summary: 'Thank your mentor when your pairing ends: optionally on their profile, to their manager, and as praise in a channel',
10469
+ },
10066
10470
  {
10067
10471
  access: 'write',
10068
10472
  command: ['network', 'claim'],
@@ -12393,6 +12797,10 @@ export const commands = [
12393
12797
  const: 'feed',
12394
12798
  type: 'string',
12395
12799
  },
12800
+ {
12801
+ const: 'mentorship',
12802
+ type: 'string',
12803
+ },
12396
12804
  {
12397
12805
  const: 'nudge',
12398
12806
  type: 'string',
@@ -15953,7 +16361,7 @@ export const commands = [
15953
16361
  path: ['reports', 'mentorship'],
15954
16362
  permission: 'reports.mentorship',
15955
16363
  scope: 'reports:read',
15956
- summary: 'Mentorship over 30, 90 or 180 days against the period before: pairs started, ended early and completed, check-ins answered and met, pairs meeting and mentees waiting now; `programId` narrows it. Never goals',
16364
+ summary: 'Mentorship over 30, 90 or 180 days against the period before: pairs started, ended early and completed, check-ins answered and met, pairs meeting and mentees waiting now; `programId` narrows it. `outcomes` compares people who were in a pairing with peers at similar tenure, hidden under five people. Never anyone’s goals',
15957
16365
  },
15958
16366
  {
15959
16367
  access: 'read',
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "dependencies": {
3
3
  "@orpc/client": "1.15.3",
4
- "@shuffl/api-contracts": "0.7.15",
5
- "@shuffl/sdk": "0.7.15"
4
+ "@shuffl/api-contracts": "0.7.16",
5
+ "@shuffl/sdk": "0.7.16"
6
6
  },
7
7
  "description": "Shuffl command line: every public API operation as a scriptable command with JSON output.",
8
8
  "engines": {
@@ -33,7 +33,7 @@
33
33
  "sideEffects": false,
34
34
  "type": "module",
35
35
  "types": "./dist/index.d.ts",
36
- "version": "0.7.15",
36
+ "version": "0.7.16",
37
37
  "bin": {
38
38
  "shuffl": "./dist/bin.js"
39
39
  }