@sprucelabs/spruce-core-schemas 35.1.192 → 36.0.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 (23) hide show
  1. package/build/.spruce/schemas/core.schemas.types.d.ts +196 -143
  2. package/build/.spruce/schemas/spruce/v2020_07_22/feedItem.schema.js +7 -15
  3. package/build/.spruce/schemas/spruce/v2020_07_22/feedItemTarget.schema.d.ts +3 -0
  4. package/build/.spruce/schemas/spruce/v2020_07_22/feedItemTarget.schema.js +39 -0
  5. package/build/.spruce/schemas/spruce/v2020_07_22/message.schema.js +6 -0
  6. package/build/.spruce/schemas/spruce/v2020_07_22/sendMessage.schema.js +6 -0
  7. package/build/esm/.spruce/schemas/core.schemas.types.d.ts +196 -143
  8. package/build/esm/.spruce/schemas/spruce/v2020_07_22/feedItem.schema.js +7 -15
  9. package/build/esm/.spruce/schemas/spruce/v2020_07_22/feedItemTarget.schema.d.ts +3 -0
  10. package/build/esm/.spruce/schemas/spruce/v2020_07_22/feedItemTarget.schema.js +37 -0
  11. package/build/esm/.spruce/schemas/spruce/v2020_07_22/message.schema.js +6 -0
  12. package/build/esm/.spruce/schemas/spruce/v2020_07_22/sendMessage.schema.js +6 -0
  13. package/build/esm/schemas/v2020_07_22/feed.builder.d.ts +52 -10
  14. package/build/esm/schemas/v2020_07_22/feed.builder.js +18 -10
  15. package/build/esm/schemas/v2020_07_22/message.builder.d.ts +4 -0
  16. package/build/esm/schemas/v2020_07_22/message.builder.js +4 -0
  17. package/build/esm/schemas/v2020_07_22/sendMessage.builder.d.ts +4 -0
  18. package/build/schemas/v2020_07_22/feed.builder.d.ts +52 -10
  19. package/build/schemas/v2020_07_22/feed.builder.js +18 -10
  20. package/build/schemas/v2020_07_22/message.builder.d.ts +4 -0
  21. package/build/schemas/v2020_07_22/message.builder.js +4 -0
  22. package/build/schemas/v2020_07_22/sendMessage.builder.d.ts +4 -0
  23. package/package.json +1 -1
@@ -1638,134 +1638,12 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
1638
1638
  }
1639
1639
  type MessageTargetEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.MessageTargetSchema>;
1640
1640
  }
1641
- export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
1642
- interface SendMessage {
1643
- 'dateSent'?: number | undefined | null;
1644
- 'target': SpruceSchemas.Spruce.v2020_07_22.MessageTarget;
1645
- 'errors'?: string[] | undefined | null;
1646
- 'classification': ("auth" | "transactional" | "promotional" | "incoming");
1647
- 'status'?: ("pending" | "processing" | "sent" | "failed" | "ignored") | undefined | null;
1648
- 'body': string;
1649
- 'context'?: (Record<string, any>) | undefined | null;
1650
- 'topicId'?: string | undefined | null;
1651
- 'links'?: SpruceSchemas.Spruce.v2020_07_22.Link[] | undefined | null;
1652
- 'choices'?: SpruceSchemas.Spruce.v2020_07_22.Choice[] | undefined | null;
1653
- }
1654
- interface SendMessageSchema extends SpruceSchema.Schema {
1655
- id: 'sendMessage';
1656
- version: 'v2020_07_22';
1657
- namespace: 'Spruce';
1658
- name: '';
1659
- moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
1660
- fields: {
1661
- /** . */
1662
- 'dateSent': {
1663
- type: 'number';
1664
- options: undefined;
1665
- };
1666
- /** . */
1667
- 'target': {
1668
- type: 'schema';
1669
- isRequired: true;
1670
- options: {
1671
- schema: SpruceSchemas.Spruce.v2020_07_22.MessageTargetSchema;
1672
- };
1673
- };
1674
- /** . */
1675
- 'errors': {
1676
- type: 'text';
1677
- isPrivate: true;
1678
- isArray: true;
1679
- options: undefined;
1680
- };
1681
- /** . */
1682
- 'classification': {
1683
- type: 'select';
1684
- isRequired: true;
1685
- options: {
1686
- choices: [{
1687
- "value": "auth";
1688
- "label": "Auth";
1689
- }, {
1690
- "value": "transactional";
1691
- "label": "transactional";
1692
- }, {
1693
- "value": "promotional";
1694
- "label": "Promotional";
1695
- }, {
1696
- "value": "incoming";
1697
- "label": "incoming";
1698
- }];
1699
- };
1700
- };
1701
- /** . */
1702
- 'status': {
1703
- type: 'select';
1704
- isPrivate: true;
1705
- defaultValue: "pending";
1706
- options: {
1707
- choices: [{
1708
- "value": "pending";
1709
- "label": "Pending";
1710
- }, {
1711
- "value": "processing";
1712
- "label": "Processing";
1713
- }, {
1714
- "value": "sent";
1715
- "label": "Sent";
1716
- }, {
1717
- "value": "failed";
1718
- "label": "Failed";
1719
- }, {
1720
- "value": "ignored";
1721
- "label": "Ignored";
1722
- }];
1723
- };
1724
- };
1725
- /** . */
1726
- 'body': {
1727
- type: 'text';
1728
- isRequired: true;
1729
- options: undefined;
1730
- };
1731
- /** . */
1732
- 'context': {
1733
- type: 'raw';
1734
- isPrivate: true;
1735
- options: {
1736
- valueType: `Record<string, any>`;
1737
- };
1738
- };
1739
- /** . */
1740
- 'topicId': {
1741
- type: 'id';
1742
- options: undefined;
1743
- };
1744
- /** . */
1745
- 'links': {
1746
- type: 'schema';
1747
- isArray: true;
1748
- minArrayLength: 0;
1749
- options: {
1750
- schema: SpruceSchemas.Spruce.v2020_07_22.LinkSchema;
1751
- };
1752
- };
1753
- /** . */
1754
- 'choices': {
1755
- type: 'schema';
1756
- isArray: true;
1757
- options: {
1758
- schema: SpruceSchemas.Spruce.v2020_07_22.ChoiceSchema;
1759
- };
1760
- };
1761
- };
1762
- }
1763
- type SendMessageEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.SendMessageSchema>;
1764
- }
1765
1641
  export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
1766
1642
  /** A discrete communication between two humans or a human and a machine. */
1767
1643
  interface Message {
1768
1644
  'id': string;
1645
+ /** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
1646
+ 'trackingId'?: string | undefined | null;
1769
1647
  'dateCreated': number;
1770
1648
  'dateSent'?: number | undefined | null;
1771
1649
  'target': SpruceSchemas.Spruce.v2020_07_22.MessageTarget;
@@ -1793,6 +1671,12 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
1793
1671
  isRequired: true;
1794
1672
  options: undefined;
1795
1673
  };
1674
+ /** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
1675
+ 'trackingId': {
1676
+ type: 'id';
1677
+ hint: 'An arbitrary id that can be used to track this message when being sent and not yet assigned an Id.';
1678
+ options: undefined;
1679
+ };
1796
1680
  /** . */
1797
1681
  'dateCreated': {
1798
1682
  type: 'number';
@@ -3090,6 +2974,52 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
3090
2974
  }
3091
2975
  type LinkEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.LinkSchema>;
3092
2976
  }
2977
+ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
2978
+ interface FeedItemTarget {
2979
+ 'personId'?: string | undefined | null;
2980
+ 'personCasualName'?: string | undefined | null;
2981
+ 'personAvatar'?: SpruceSchema.ImageFieldValue | undefined | null;
2982
+ 'skillId'?: string | undefined | null;
2983
+ 'skillName'?: string | undefined | null;
2984
+ }
2985
+ interface FeedItemTargetSchema extends SpruceSchema.Schema {
2986
+ id: 'feedItemTarget';
2987
+ version: 'v2020_07_22';
2988
+ namespace: 'Spruce';
2989
+ name: '';
2990
+ moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
2991
+ fields: {
2992
+ /** . */
2993
+ 'personId': {
2994
+ type: 'id';
2995
+ options: undefined;
2996
+ };
2997
+ /** . */
2998
+ 'personCasualName': {
2999
+ type: 'text';
3000
+ options: undefined;
3001
+ };
3002
+ /** . */
3003
+ 'personAvatar': {
3004
+ type: 'image';
3005
+ options: {
3006
+ requiredSizes: ["*"];
3007
+ };
3008
+ };
3009
+ /** . */
3010
+ 'skillId': {
3011
+ type: 'id';
3012
+ options: undefined;
3013
+ };
3014
+ /** . */
3015
+ 'skillName': {
3016
+ type: 'text';
3017
+ options: undefined;
3018
+ };
3019
+ };
3020
+ }
3021
+ type FeedItemTargetEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.FeedItemTargetSchema>;
3022
+ }
3093
3023
  export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
3094
3024
  interface Choice {
3095
3025
  'value': string;
@@ -3118,16 +3048,146 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
3118
3048
  }
3119
3049
  type ChoiceEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.ChoiceSchema>;
3120
3050
  }
3051
+ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
3052
+ interface SendMessage {
3053
+ /** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
3054
+ 'trackingId'?: string | undefined | null;
3055
+ 'dateSent'?: number | undefined | null;
3056
+ 'target': SpruceSchemas.Spruce.v2020_07_22.MessageTarget;
3057
+ 'errors'?: string[] | undefined | null;
3058
+ 'classification': ("auth" | "transactional" | "promotional" | "incoming");
3059
+ 'status'?: ("pending" | "processing" | "sent" | "failed" | "ignored") | undefined | null;
3060
+ 'body': string;
3061
+ 'context'?: (Record<string, any>) | undefined | null;
3062
+ 'topicId'?: string | undefined | null;
3063
+ 'links'?: SpruceSchemas.Spruce.v2020_07_22.Link[] | undefined | null;
3064
+ 'choices'?: SpruceSchemas.Spruce.v2020_07_22.Choice[] | undefined | null;
3065
+ }
3066
+ interface SendMessageSchema extends SpruceSchema.Schema {
3067
+ id: 'sendMessage';
3068
+ version: 'v2020_07_22';
3069
+ namespace: 'Spruce';
3070
+ name: '';
3071
+ moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
3072
+ fields: {
3073
+ /** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
3074
+ 'trackingId': {
3075
+ type: 'id';
3076
+ hint: 'An arbitrary id that can be used to track this message when being sent and not yet assigned an Id.';
3077
+ options: undefined;
3078
+ };
3079
+ /** . */
3080
+ 'dateSent': {
3081
+ type: 'number';
3082
+ options: undefined;
3083
+ };
3084
+ /** . */
3085
+ 'target': {
3086
+ type: 'schema';
3087
+ isRequired: true;
3088
+ options: {
3089
+ schema: SpruceSchemas.Spruce.v2020_07_22.MessageTargetSchema;
3090
+ };
3091
+ };
3092
+ /** . */
3093
+ 'errors': {
3094
+ type: 'text';
3095
+ isPrivate: true;
3096
+ isArray: true;
3097
+ options: undefined;
3098
+ };
3099
+ /** . */
3100
+ 'classification': {
3101
+ type: 'select';
3102
+ isRequired: true;
3103
+ options: {
3104
+ choices: [{
3105
+ "value": "auth";
3106
+ "label": "Auth";
3107
+ }, {
3108
+ "value": "transactional";
3109
+ "label": "transactional";
3110
+ }, {
3111
+ "value": "promotional";
3112
+ "label": "Promotional";
3113
+ }, {
3114
+ "value": "incoming";
3115
+ "label": "incoming";
3116
+ }];
3117
+ };
3118
+ };
3119
+ /** . */
3120
+ 'status': {
3121
+ type: 'select';
3122
+ isPrivate: true;
3123
+ defaultValue: "pending";
3124
+ options: {
3125
+ choices: [{
3126
+ "value": "pending";
3127
+ "label": "Pending";
3128
+ }, {
3129
+ "value": "processing";
3130
+ "label": "Processing";
3131
+ }, {
3132
+ "value": "sent";
3133
+ "label": "Sent";
3134
+ }, {
3135
+ "value": "failed";
3136
+ "label": "Failed";
3137
+ }, {
3138
+ "value": "ignored";
3139
+ "label": "Ignored";
3140
+ }];
3141
+ };
3142
+ };
3143
+ /** . */
3144
+ 'body': {
3145
+ type: 'text';
3146
+ isRequired: true;
3147
+ options: undefined;
3148
+ };
3149
+ /** . */
3150
+ 'context': {
3151
+ type: 'raw';
3152
+ isPrivate: true;
3153
+ options: {
3154
+ valueType: `Record<string, any>`;
3155
+ };
3156
+ };
3157
+ /** . */
3158
+ 'topicId': {
3159
+ type: 'id';
3160
+ options: undefined;
3161
+ };
3162
+ /** . */
3163
+ 'links': {
3164
+ type: 'schema';
3165
+ isArray: true;
3166
+ minArrayLength: 0;
3167
+ options: {
3168
+ schema: SpruceSchemas.Spruce.v2020_07_22.LinkSchema;
3169
+ };
3170
+ };
3171
+ /** . */
3172
+ 'choices': {
3173
+ type: 'schema';
3174
+ isArray: true;
3175
+ options: {
3176
+ schema: SpruceSchemas.Spruce.v2020_07_22.ChoiceSchema;
3177
+ };
3178
+ };
3179
+ };
3180
+ }
3181
+ type SendMessageEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.SendMessageSchema>;
3182
+ }
3121
3183
  export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
3122
3184
  interface FeedItem {
3123
3185
  'id': string;
3124
- 'isMe'?: boolean | undefined | null;
3125
3186
  'message': string;
3126
3187
  'dateCreated': SpruceSchema.DateTimeFieldValue;
3127
3188
  'note'?: string | undefined | null;
3128
- 'isSprucebot'?: boolean | undefined | null;
3129
- 'source'?: (Record<string, any>) | undefined | null;
3130
- 'fromCasualName': string;
3189
+ 'source': SpruceSchemas.Spruce.v2020_07_22.FeedItemTarget;
3190
+ 'target': SpruceSchemas.Spruce.v2020_07_22.FeedItemTarget;
3131
3191
  'avatar'?: SpruceSchema.ImageFieldValue | undefined | null;
3132
3192
  'choices'?: SpruceSchemas.Spruce.v2020_07_22.Choice[] | undefined | null;
3133
3193
  'links'?: SpruceSchemas.Spruce.v2020_07_22.Link[] | undefined | null;
@@ -3146,11 +3206,6 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
3146
3206
  options: undefined;
3147
3207
  };
3148
3208
  /** . */
3149
- 'isMe': {
3150
- type: 'boolean';
3151
- options: undefined;
3152
- };
3153
- /** . */
3154
3209
  'message': {
3155
3210
  type: 'text';
3156
3211
  isRequired: true;
@@ -3168,22 +3223,20 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
3168
3223
  options: undefined;
3169
3224
  };
3170
3225
  /** . */
3171
- 'isSprucebot': {
3172
- type: 'boolean';
3173
- options: undefined;
3174
- };
3175
- /** . */
3176
3226
  'source': {
3177
- type: 'raw';
3227
+ type: 'schema';
3228
+ isRequired: true;
3178
3229
  options: {
3179
- valueType: `Record<string, any>`;
3230
+ schema: SpruceSchemas.Spruce.v2020_07_22.FeedItemTargetSchema;
3180
3231
  };
3181
3232
  };
3182
3233
  /** . */
3183
- 'fromCasualName': {
3184
- type: 'text';
3234
+ 'target': {
3235
+ type: 'schema';
3185
3236
  isRequired: true;
3186
- options: undefined;
3237
+ options: {
3238
+ schema: SpruceSchemas.Spruce.v2020_07_22.FeedItemTargetSchema;
3239
+ };
3187
3240
  };
3188
3241
  /** . */
3189
3242
  'avatar': {
@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  const schema_1 = require("@sprucelabs/schema");
7
+ const feedItemTarget_schema_1 = __importDefault(require("./feedItemTarget.schema"));
7
8
  const choice_schema_1 = __importDefault(require("./choice.schema"));
8
9
  const link_schema_1 = __importDefault(require("./link.schema"));
9
10
  const feedItemSchema = {
@@ -20,11 +21,6 @@ const feedItemSchema = {
20
21
  options: undefined
21
22
  },
22
23
  /** . */
23
- 'isMe': {
24
- type: 'boolean',
25
- options: undefined
26
- },
27
- /** . */
28
24
  'message': {
29
25
  type: 'text',
30
26
  isRequired: true,
@@ -42,20 +38,16 @@ const feedItemSchema = {
42
38
  options: undefined
43
39
  },
44
40
  /** . */
45
- 'isSprucebot': {
46
- type: 'boolean',
47
- options: undefined
48
- },
49
- /** . */
50
41
  'source': {
51
- type: 'raw',
52
- options: { valueType: `Record<string, any>`, }
42
+ type: 'schema',
43
+ isRequired: true,
44
+ options: { schema: feedItemTarget_schema_1.default, }
53
45
  },
54
46
  /** . */
55
- 'fromCasualName': {
56
- type: 'text',
47
+ 'target': {
48
+ type: 'schema',
57
49
  isRequired: true,
58
- options: undefined
50
+ options: { schema: feedItemTarget_schema_1.default, }
59
51
  },
60
52
  /** . */
61
53
  'avatar': {
@@ -0,0 +1,3 @@
1
+ import { SpruceSchemas } from '../../core.schemas.types';
2
+ declare const feedItemTargetSchema: SpruceSchemas.Spruce.v2020_07_22.FeedItemTargetSchema;
3
+ export default feedItemTargetSchema;
@@ -0,0 +1,39 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const schema_1 = require("@sprucelabs/schema");
4
+ const feedItemTargetSchema = {
5
+ id: 'feedItemTarget',
6
+ version: 'v2020_07_22',
7
+ namespace: 'Spruce',
8
+ name: '',
9
+ moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas',
10
+ fields: {
11
+ /** . */
12
+ 'personId': {
13
+ type: 'id',
14
+ options: undefined
15
+ },
16
+ /** . */
17
+ 'personCasualName': {
18
+ type: 'text',
19
+ options: undefined
20
+ },
21
+ /** . */
22
+ 'personAvatar': {
23
+ type: 'image',
24
+ options: { requiredSizes: ["*"], }
25
+ },
26
+ /** . */
27
+ 'skillId': {
28
+ type: 'id',
29
+ options: undefined
30
+ },
31
+ /** . */
32
+ 'skillName': {
33
+ type: 'text',
34
+ options: undefined
35
+ },
36
+ }
37
+ };
38
+ schema_1.SchemaRegistry.getInstance().trackSchema(feedItemTargetSchema);
39
+ exports.default = feedItemTargetSchema;
@@ -22,6 +22,12 @@ const messageSchema = {
22
22
  isRequired: true,
23
23
  options: undefined
24
24
  },
25
+ /** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
26
+ 'trackingId': {
27
+ type: 'id',
28
+ hint: 'An arbitrary id that can be used to track this message when being sent and not yet assigned an Id.',
29
+ options: undefined
30
+ },
25
31
  /** . */
26
32
  'dateCreated': {
27
33
  type: 'number',
@@ -14,6 +14,12 @@ const sendMessageSchema = {
14
14
  name: '',
15
15
  moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas',
16
16
  fields: {
17
+ /** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
18
+ 'trackingId': {
19
+ type: 'id',
20
+ hint: 'An arbitrary id that can be used to track this message when being sent and not yet assigned an Id.',
21
+ options: undefined
22
+ },
17
23
  /** . */
18
24
  'dateSent': {
19
25
  type: 'number',