npm - @sprucelabs/spruce-core-schemas - Versions diffs - 35.1.192 → 36.0.0 - Mend

@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

package/build/esm/.spruce/schemas/core.schemas.types.d.ts CHANGED Viewed

@@ -1638,134 +1638,12 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
     }
     type MessageTargetEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.MessageTargetSchema>;
 }
-export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
-    interface SendMessage {
-        'dateSent'?: number | undefined | null;
-        'target': SpruceSchemas.Spruce.v2020_07_22.MessageTarget;
-        'errors'?: string[] | undefined | null;
-        'classification': ("auth" | "transactional" | "promotional" | "incoming");
-        'status'?: ("pending" | "processing" | "sent" | "failed" | "ignored") | undefined | null;
-        'body': string;
-        'context'?: (Record<string, any>) | undefined | null;
-        'topicId'?: string | undefined | null;
-        'links'?: SpruceSchemas.Spruce.v2020_07_22.Link[] | undefined | null;
-        'choices'?: SpruceSchemas.Spruce.v2020_07_22.Choice[] | undefined | null;
-    }
-    interface SendMessageSchema extends SpruceSchema.Schema {
-        id: 'sendMessage';
-        version: 'v2020_07_22';
-        namespace: 'Spruce';
-        name: '';
-        moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
-        fields: {
-            /** . */
-            'dateSent': {
-                type: 'number';
-                options: undefined;
-            };
-            /** . */
-            'target': {
-                type: 'schema';
-                isRequired: true;
-                options: {
-                    schema: SpruceSchemas.Spruce.v2020_07_22.MessageTargetSchema;
-                };
-            };
-            /** . */
-            'errors': {
-                type: 'text';
-                isPrivate: true;
-                isArray: true;
-                options: undefined;
-            };
-            /** . */
-            'classification': {
-                type: 'select';
-                isRequired: true;
-                options: {
-                    choices: [{
-                        "value": "auth";
-                        "label": "Auth";
-                    }, {
-                        "value": "transactional";
-                        "label": "transactional";
-                    }, {
-                        "value": "promotional";
-                        "label": "Promotional";
-                    }, {
-                        "value": "incoming";
-                        "label": "incoming";
-                    }];
-                };
-            };
-            /** . */
-            'status': {
-                type: 'select';
-                isPrivate: true;
-                defaultValue: "pending";
-                options: {
-                    choices: [{
-                        "value": "pending";
-                        "label": "Pending";
-                    }, {
-                        "value": "processing";
-                        "label": "Processing";
-                    }, {
-                        "value": "sent";
-                        "label": "Sent";
-                    }, {
-                        "value": "failed";
-                        "label": "Failed";
-                    }, {
-                        "value": "ignored";
-                        "label": "Ignored";
-                    }];
-                };
-            };
-            /** . */
-            'body': {
-                type: 'text';
-                isRequired: true;
-                options: undefined;
-            };
-            /** . */
-            'context': {
-                type: 'raw';
-                isPrivate: true;
-                options: {
-                    valueType: `Record<string, any>`;
-                };
-            };
-            /** . */
-            'topicId': {
-                type: 'id';
-                options: undefined;
-            };
-            /** . */
-            'links': {
-                type: 'schema';
-                isArray: true;
-                minArrayLength: 0;
-                options: {
-                    schema: SpruceSchemas.Spruce.v2020_07_22.LinkSchema;
-                };
-            };
-            /** . */
-            'choices': {
-                type: 'schema';
-                isArray: true;
-                options: {
-                    schema: SpruceSchemas.Spruce.v2020_07_22.ChoiceSchema;
-                };
-            };
-        };
-    }
-    type SendMessageEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.SendMessageSchema>;
-}
 export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
     /** A discrete communication between two humans or a human and a machine. */
     interface Message {
         'id': string;
+        /** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
+        'trackingId'?: string | undefined | null;
         'dateCreated': number;
         'dateSent'?: number | undefined | null;
         'target': SpruceSchemas.Spruce.v2020_07_22.MessageTarget;
@@ -1793,6 +1671,12 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
                 isRequired: true;
                 options: undefined;
             };
+            /** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
+            'trackingId': {
+                type: 'id';
+                hint: 'An arbitrary id that can be used to track this message when being sent and not yet assigned an Id.';
+                options: undefined;
+            };
             /** . */
             'dateCreated': {
                 type: 'number';
@@ -3090,6 +2974,52 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
     }
     type LinkEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.LinkSchema>;
 }
+export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
+    interface FeedItemTarget {
+        'personId'?: string | undefined | null;
+        'personCasualName'?: string | undefined | null;
+        'personAvatar'?: SpruceSchema.ImageFieldValue | undefined | null;
+        'skillId'?: string | undefined | null;
+        'skillName'?: string | undefined | null;
+    }
+    interface FeedItemTargetSchema extends SpruceSchema.Schema {
+        id: 'feedItemTarget';
+        version: 'v2020_07_22';
+        namespace: 'Spruce';
+        name: '';
+        moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
+        fields: {
+            /** . */
+            'personId': {
+                type: 'id';
+                options: undefined;
+            };
+            /** . */
+            'personCasualName': {
+                type: 'text';
+                options: undefined;
+            };
+            /** . */
+            'personAvatar': {
+                type: 'image';
+                options: {
+                    requiredSizes: ["*"];
+                };
+            };
+            /** . */
+            'skillId': {
+                type: 'id';
+                options: undefined;
+            };
+            /** . */
+            'skillName': {
+                type: 'text';
+                options: undefined;
+            };
+        };
+    }
+    type FeedItemTargetEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.FeedItemTargetSchema>;
+}
 export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
     interface Choice {
         'value': string;
@@ -3118,16 +3048,146 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
     }
     type ChoiceEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.ChoiceSchema>;
 }
+export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
+    interface SendMessage {
+        /** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
+        'trackingId'?: string | undefined | null;
+        'dateSent'?: number | undefined | null;
+        'target': SpruceSchemas.Spruce.v2020_07_22.MessageTarget;
+        'errors'?: string[] | undefined | null;
+        'classification': ("auth" | "transactional" | "promotional" | "incoming");
+        'status'?: ("pending" | "processing" | "sent" | "failed" | "ignored") | undefined | null;
+        'body': string;
+        'context'?: (Record<string, any>) | undefined | null;
+        'topicId'?: string | undefined | null;
+        'links'?: SpruceSchemas.Spruce.v2020_07_22.Link[] | undefined | null;
+        'choices'?: SpruceSchemas.Spruce.v2020_07_22.Choice[] | undefined | null;
+    }
+    interface SendMessageSchema extends SpruceSchema.Schema {
+        id: 'sendMessage';
+        version: 'v2020_07_22';
+        namespace: 'Spruce';
+        name: '';
+        moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas';
+        fields: {
+            /** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
+            'trackingId': {
+                type: 'id';
+                hint: 'An arbitrary id that can be used to track this message when being sent and not yet assigned an Id.';
+                options: undefined;
+            };
+            /** . */
+            'dateSent': {
+                type: 'number';
+                options: undefined;
+            };
+            /** . */
+            'target': {
+                type: 'schema';
+                isRequired: true;
+                options: {
+                    schema: SpruceSchemas.Spruce.v2020_07_22.MessageTargetSchema;
+                };
+            };
+            /** . */
+            'errors': {
+                type: 'text';
+                isPrivate: true;
+                isArray: true;
+                options: undefined;
+            };
+            /** . */
+            'classification': {
+                type: 'select';
+                isRequired: true;
+                options: {
+                    choices: [{
+                        "value": "auth";
+                        "label": "Auth";
+                    }, {
+                        "value": "transactional";
+                        "label": "transactional";
+                    }, {
+                        "value": "promotional";
+                        "label": "Promotional";
+                    }, {
+                        "value": "incoming";
+                        "label": "incoming";
+                    }];
+                };
+            };
+            /** . */
+            'status': {
+                type: 'select';
+                isPrivate: true;
+                defaultValue: "pending";
+                options: {
+                    choices: [{
+                        "value": "pending";
+                        "label": "Pending";
+                    }, {
+                        "value": "processing";
+                        "label": "Processing";
+                    }, {
+                        "value": "sent";
+                        "label": "Sent";
+                    }, {
+                        "value": "failed";
+                        "label": "Failed";
+                    }, {
+                        "value": "ignored";
+                        "label": "Ignored";
+                    }];
+                };
+            };
+            /** . */
+            'body': {
+                type: 'text';
+                isRequired: true;
+                options: undefined;
+            };
+            /** . */
+            'context': {
+                type: 'raw';
+                isPrivate: true;
+                options: {
+                    valueType: `Record<string, any>`;
+                };
+            };
+            /** . */
+            'topicId': {
+                type: 'id';
+                options: undefined;
+            };
+            /** . */
+            'links': {
+                type: 'schema';
+                isArray: true;
+                minArrayLength: 0;
+                options: {
+                    schema: SpruceSchemas.Spruce.v2020_07_22.LinkSchema;
+                };
+            };
+            /** . */
+            'choices': {
+                type: 'schema';
+                isArray: true;
+                options: {
+                    schema: SpruceSchemas.Spruce.v2020_07_22.ChoiceSchema;
+                };
+            };
+        };
+    }
+    type SendMessageEntity = SchemaEntity<SpruceSchemas.Spruce.v2020_07_22.SendMessageSchema>;
+}
 export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
     interface FeedItem {
         'id': string;
-        'isMe'?: boolean | undefined | null;
         'message': string;
         'dateCreated': SpruceSchema.DateTimeFieldValue;
         'note'?: string | undefined | null;
-        'isSprucebot'?: boolean | undefined | null;
-        'source'?: (Record<string, any>) | undefined | null;
-        'fromCasualName': string;
+        'source': SpruceSchemas.Spruce.v2020_07_22.FeedItemTarget;
+        'target': SpruceSchemas.Spruce.v2020_07_22.FeedItemTarget;
         'avatar'?: SpruceSchema.ImageFieldValue | undefined | null;
         'choices'?: SpruceSchemas.Spruce.v2020_07_22.Choice[] | undefined | null;
         'links'?: SpruceSchemas.Spruce.v2020_07_22.Link[] | undefined | null;
@@ -3146,11 +3206,6 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
                 options: undefined;
             };
             /** . */
-            'isMe': {
-                type: 'boolean';
-                options: undefined;
-            };
-            /** . */
             'message': {
                 type: 'text';
                 isRequired: true;
@@ -3168,22 +3223,20 @@ export declare namespace SpruceSchemas.Spruce.v2020_07_22 {
                 options: undefined;
             };
             /** . */
-            'isSprucebot': {
-                type: 'boolean';
-                options: undefined;
-            };
-            /** . */
             'source': {
-                type: 'raw';
+                type: 'schema';
+                isRequired: true;
                 options: {
-                    valueType: `Record<string, any>`;
+                    schema: SpruceSchemas.Spruce.v2020_07_22.FeedItemTargetSchema;
                 };
             };
             /** . */
-            'fromCasualName': {
-                type: 'text';
+            'target': {
+                type: 'schema';
                 isRequired: true;
-                options: undefined;
+                options: {
+                    schema: SpruceSchemas.Spruce.v2020_07_22.FeedItemTargetSchema;
+                };
             };
             /** . */
             'avatar': {

package/build/esm/.spruce/schemas/spruce/v2020_07_22/feedItem.schema.js CHANGED Viewed

@@ -1,4 +1,5 @@
 import { SchemaRegistry } from '@sprucelabs/schema';
+import feedItemTargetSchema_v2020_07_22 from './feedItemTarget.schema.js';
 import choiceSchema_v2020_07_22 from './choice.schema.js';
 import linkSchema_v2020_07_22 from './link.schema.js';
 const feedItemSchema = {
@@ -15,11 +16,6 @@ const feedItemSchema = {
             options: undefined
         },
         /** . */
-        'isMe': {
-            type: 'boolean',
-            options: undefined
-        },
-        /** . */
         'message': {
             type: 'text',
             isRequired: true,
@@ -37,20 +33,16 @@ const feedItemSchema = {
             options: undefined
         },
         /** . */
-        'isSprucebot': {
-            type: 'boolean',
-            options: undefined
-        },
-        /** . */
         'source': {
-            type: 'raw',
-            options: { valueType: `Record<string, any>`, }
+            type: 'schema',
+            isRequired: true,
+            options: { schema: feedItemTargetSchema_v2020_07_22, }
         },
         /** . */
-        'fromCasualName': {
-            type: 'text',
+        'target': {
+            type: 'schema',
             isRequired: true,
-            options: undefined
+            options: { schema: feedItemTargetSchema_v2020_07_22, }
         },
         /** . */
         'avatar': {

package/build/esm/.spruce/schemas/spruce/v2020_07_22/feedItemTarget.schema.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { SpruceSchemas } from '../../core.schemas.types';
+declare const feedItemTargetSchema: SpruceSchemas.Spruce.v2020_07_22.FeedItemTargetSchema;
+export default feedItemTargetSchema;

package/build/esm/.spruce/schemas/spruce/v2020_07_22/feedItemTarget.schema.js ADDED Viewed

@@ -0,0 +1,37 @@
+import { SchemaRegistry } from '@sprucelabs/schema';
+const feedItemTargetSchema = {
+    id: 'feedItemTarget',
+    version: 'v2020_07_22',
+    namespace: 'Spruce',
+    name: '',
+    moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas',
+    fields: {
+        /** . */
+        'personId': {
+            type: 'id',
+            options: undefined
+        },
+        /** . */
+        'personCasualName': {
+            type: 'text',
+            options: undefined
+        },
+        /** . */
+        'personAvatar': {
+            type: 'image',
+            options: { requiredSizes: ["*"], }
+        },
+        /** . */
+        'skillId': {
+            type: 'id',
+            options: undefined
+        },
+        /** . */
+        'skillName': {
+            type: 'text',
+            options: undefined
+        },
+    }
+};
+SchemaRegistry.getInstance().trackSchema(feedItemTargetSchema);
+export default feedItemTargetSchema;

package/build/esm/.spruce/schemas/spruce/v2020_07_22/message.schema.js CHANGED Viewed

@@ -17,6 +17,12 @@ const messageSchema = {
             isRequired: true,
             options: undefined
         },
+        /** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
+        'trackingId': {
+            type: 'id',
+            hint: 'An arbitrary id that can be used to track this message when being sent and not yet assigned an Id.',
+            options: undefined
+        },
         /** . */
         'dateCreated': {
             type: 'number',

package/build/esm/.spruce/schemas/spruce/v2020_07_22/sendMessage.schema.js CHANGED Viewed

@@ -9,6 +9,12 @@ const sendMessageSchema = {
     name: '',
     moduleToImportFromWhenRemote: '@sprucelabs/spruce-core-schemas',
     fields: {
+        /** . An arbitrary id that can be used to track this message when being sent and not yet assigned an Id. */
+        'trackingId': {
+            type: 'id',
+            hint: 'An arbitrary id that can be used to track this message when being sent and not yet assigned an Id.',
+            options: undefined
+        },
         /** . */
         'dateSent': {
             type: 'number',

package/build/esm/schemas/v2020_07_22/feed.builder.d.ts CHANGED Viewed

@@ -14,9 +14,6 @@ declare const _default: {
                             type: "id";
                             isRequired: true;
                         };
-                        isMe: {
-                            type: "boolean";
-                        };
                         message: {
                             type: "text";
                             isRequired: true;
@@ -28,18 +25,63 @@ declare const _default: {
                         note: {
                             type: "text";
                         };
-                        isSprucebot: {
-                            type: "boolean";
-                        };
                         source: {
-                            type: "raw";
+                            type: "schema";
+                            isRequired: true;
                             options: {
-                                valueType: string;
+                                schema: {
+                                    id: string;
+                                    fields: {
+                                        personId: {
+                                            type: "id";
+                                        };
+                                        personCasualName: {
+                                            type: "text";
+                                        };
+                                        personAvatar: {
+                                            type: "image";
+                                            options: {
+                                                requiredSizes: "*"[];
+                                            };
+                                        };
+                                        skillId: {
+                                            type: "id";
+                                        };
+                                        skillName: {
+                                            type: "text";
+                                        };
+                                    };
+                                };
                             };
                         };
-                        fromCasualName: {
-                            type: "text";
+                        target: {
+                            type: "schema";
                             isRequired: true;
+                            options: {
+                                schema: {
+                                    id: string;
+                                    fields: {
+                                        personId: {
+                                            type: "id";
+                                        };
+                                        personCasualName: {
+                                            type: "text";
+                                        };
+                                        personAvatar: {
+                                            type: "image";
+                                            options: {
+                                                requiredSizes: "*"[];
+                                            };
+                                        };
+                                        skillId: {
+                                            type: "id";
+                                        };
+                                        skillName: {
+                                            type: "text";
+                                        };
+                                    };
+                                };
+                            };
                         };
                         avatar: {
                             type: "image";

package/build/esm/schemas/v2020_07_22/feed.builder.js CHANGED Viewed

@@ -1,6 +1,16 @@
 import { buildSchema } from '@sprucelabs/schema';
 import choiceBuilder from './choice.builder.js';
 import linkBuilder from './link.builder.js';
+const feedItemTargetSchema = buildSchema({
+    id: 'feedItemTarget',
+    fields: {
+        personId: { type: 'id' },
+        personCasualName: { type: 'text' },
+        personAvatar: { type: 'image', options: { requiredSizes: ['*'] } },
+        skillId: { type: 'id' },
+        skillName: { type: 'text' },
+    },
+});
 const feedItemSchema = buildSchema({
     id: 'feedItem',
     fields: {
@@ -8,9 +18,6 @@ const feedItemSchema = buildSchema({
             type: 'id',
             isRequired: true,
         },
-        isMe: {
-            type: 'boolean',
-        },
         message: {
             type: 'text',
             isRequired: true,
@@ -22,18 +29,19 @@ const feedItemSchema = buildSchema({
         note: {
             type: 'text',
         },
-        isSprucebot: {
-            type: 'boolean',
-        },
         source: {
-            type: 'raw',
+            type: 'schema',
+            isRequired: true,
             options: {
-                valueType: 'Record<string, any>',
+                schema: feedItemTargetSchema,
             },
         },
-        fromCasualName: {
-            type: 'text',
+        target: {
+            type: 'schema',
             isRequired: true,
+            options: {
+                schema: feedItemTargetSchema,
+            },
         },
         avatar: {
             type: 'image',

package/build/esm/schemas/v2020_07_22/message.builder.d.ts CHANGED Viewed

@@ -52,6 +52,10 @@ declare const _default: {
             type: "id";
             isRequired: true;
         };
+        trackingId: {
+            type: "id";
+            hint: string;
+        };
         dateCreated: {
             type: "number";
             isRequired: true;

package/build/esm/schemas/v2020_07_22/message.builder.js CHANGED Viewed

@@ -38,6 +38,10 @@ export default buildSchema({
             type: 'id',
             isRequired: true,
         },
+        trackingId: {
+            type: 'id',
+            hint: 'An arbitrary id that can be used to track this message when being sent and not yet assigned an Id.',
+        },
         dateCreated: {
             type: 'number',
             isRequired: true,

package/build/esm/schemas/v2020_07_22/sendMessage.builder.d.ts CHANGED Viewed

@@ -76,6 +76,10 @@ declare const _default: {
                 };
             };
         };
+        trackingId: {
+            type: "id";
+            hint: string;
+        };
         dateSent: {
             type: "number";
         };