@bigfootai/bigfoot-types 5.1.30 → 5.1.32

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.
@@ -44,11 +44,6 @@ exports.AccountOverview = {
44
44
  blockType: model_1.BlockType.Table,
45
45
  },
46
46
  ],
47
- classifiers: [
48
- 'account summary',
49
- 'account overview',
50
- 'account briefing',
51
- 'account plan',
52
- ],
47
+ classifiers: [],
53
48
  threshold: 0,
54
49
  };
@@ -45,11 +45,6 @@ export const AccountOverview: DashboardMetadata = {
45
45
  blockType: BlockType.Table,
46
46
  },
47
47
  ],
48
- classifiers: [
49
- 'account summary',
50
- 'account overview',
51
- 'account briefing',
52
- 'account plan',
53
- ],
48
+ classifiers: [],
54
49
  threshold: 0,
55
50
  };
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AccountOverview = void 0;
4
+ const model_1 = require("../../model");
5
+ exports.AccountOverview = {
6
+ _id: '',
7
+ dateCreated: 0,
8
+ dateUpdated: 0,
9
+ label: 'Record Update',
10
+ description: 'This template is a notification dashboard to be used when notifying users about record updates.',
11
+ metadataType: 'record_update',
12
+ blockDescriptions: [
13
+ {
14
+ title: 'What changed?',
15
+ name: 'what',
16
+ description: 'The changes that happened to create this notification',
17
+ blockType: model_1.BlockType.Changeset,
18
+ },
19
+ {
20
+ title: 'Why is this important?',
21
+ name: 'why',
22
+ description: 'Write short summary for the user that focuses on why this recommendation is important. Use the above context only. Keep the response concise, in the language of a 7th grader, and the length less than 5 sentences.',
23
+ blockType: model_1.BlockType.Section,
24
+ },
25
+ {
26
+ title: 'Potential impact of this change',
27
+ name: 'impact',
28
+ description: 'Write a short summary that assesses the potential impact of this update on alignment/business/revenue/etc for the user. Use the above context only. Keep the response concise, in the language of a 7th grader, and the length less than 5 sentences.',
29
+ blockType: model_1.BlockType.Section,
30
+ },
31
+ {
32
+ title: 'Next steps',
33
+ name: 'next_steps',
34
+ description: 'Write a short summary that helps the user understand what they could do next. Focus on any actions or tasks that may be in the notes. Use the above context only. Keep the response concise, in the language of a 7th grader, and the length less than 5 sentences.',
35
+ blockType: model_1.BlockType.Section,
36
+ },
37
+ {
38
+ title: 'Related records',
39
+ name: 'related_records',
40
+ description: 'The records related to this change',
41
+ blockType: model_1.BlockType.Table,
42
+ },
43
+ {
44
+ title: 'Related notes',
45
+ name: 'related_notes',
46
+ description: 'The records related to this change',
47
+ blockType: model_1.BlockType.Note,
48
+ },
49
+ ],
50
+ classifiers: [],
51
+ threshold: 0,
52
+ };
@@ -0,0 +1,55 @@
1
+ import { BlockType, DashboardMetadata, TagType } from '../../model';
2
+
3
+ export const AccountOverview: DashboardMetadata = {
4
+ _id: '',
5
+ dateCreated: 0,
6
+ dateUpdated: 0,
7
+ label: 'Record Update',
8
+ description:
9
+ 'This template is a notification dashboard to be used when notifying users about record updates.',
10
+ metadataType: 'record_update',
11
+ blockDescriptions: [
12
+ {
13
+ title: 'What changed?',
14
+ name: 'what',
15
+ description:
16
+ 'The changes that happened to create this notification',
17
+ blockType: BlockType.Changeset,
18
+ },
19
+ {
20
+ title: 'Why is this important?',
21
+ name: 'why',
22
+ description:
23
+ 'Write short summary for the user that focuses on why this recommendation is important. Use the above context only. Keep the response concise, in the language of a 7th grader, and the length less than 5 sentences.',
24
+ blockType: BlockType.Section,
25
+ },
26
+ {
27
+ title: 'Potential impact of this change',
28
+ name: 'impact',
29
+ description:
30
+ 'Write a short summary that assesses the potential impact of this update on alignment/business/revenue/etc for the user. Use the above context only. Keep the response concise, in the language of a 7th grader, and the length less than 5 sentences.',
31
+ blockType: BlockType.Section,
32
+ },
33
+ {
34
+ title: 'Next steps',
35
+ name: 'next_steps',
36
+ description:
37
+ 'Write a short summary that helps the user understand what they could do next. Focus on any actions or tasks that may be in the notes. Use the above context only. Keep the response concise, in the language of a 7th grader, and the length less than 5 sentences.',
38
+ blockType: BlockType.Section,
39
+ },
40
+ {
41
+ title: 'Related records',
42
+ name: 'related_records',
43
+ description: 'The records related to this change',
44
+ blockType: BlockType.Table,
45
+ },
46
+ {
47
+ title: 'Related notes',
48
+ name: 'related_notes',
49
+ description: 'The records related to this change',
50
+ blockType: BlockType.Note,
51
+ },
52
+ ],
53
+ classifiers: [],
54
+ threshold: 0,
55
+ };
@@ -9,6 +9,7 @@ exports.Case = {
9
9
  label: 'Case',
10
10
  description: 'Represents an case/ticket, which is a problem that needs to be resolved.',
11
11
  metadataType: 'case',
12
+ tasky: true,
12
13
  references: [
13
14
  'https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm',
14
15
  'https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/',
@@ -15,6 +15,7 @@ export const Case: TableMetadata = {
15
15
  description:
16
16
  'Represents an case/ticket, which is a problem that needs to be resolved.',
17
17
  metadataType: 'case',
18
+ tasky: true,
18
19
  references: [
19
20
  'https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm',
20
21
  'https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/',
@@ -1,14 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Case = void 0;
3
+ exports.Issue = void 0;
4
4
  const model_1 = require("../../model");
5
- exports.Case = {
5
+ exports.Issue = {
6
6
  _id: '',
7
7
  dateCreated: 0,
8
8
  dateUpdated: 0,
9
9
  label: 'Issue',
10
10
  description: 'Represents an issue or feature enhancement, which is a request to improve a product or service.',
11
11
  metadataType: 'issue',
12
+ tasky: true,
12
13
  references: [
13
14
  'https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm',
14
15
  'https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/',
@@ -7,7 +7,7 @@ import {
7
7
  TaskStatus,
8
8
  } from '../../model';
9
9
 
10
- export const Case: TableMetadata = {
10
+ export const Issue: TableMetadata = {
11
11
  _id: '',
12
12
  dateCreated: 0,
13
13
  dateUpdated: 0,
@@ -15,6 +15,7 @@ export const Case: TableMetadata = {
15
15
  description:
16
16
  'Represents an issue or feature enhancement, which is a request to improve a product or service.',
17
17
  metadataType: 'issue',
18
+ tasky: true,
18
19
  references: [
19
20
  'https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm',
20
21
  'https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/',
@@ -9,6 +9,7 @@ exports.Opportunity = {
9
9
  label: 'Opportunity',
10
10
  description: 'Represents an opportunity, which is a sale or pending deal.',
11
11
  metadataType: 'opportunity',
12
+ tasky: true,
12
13
  references: [
13
14
  'https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm',
14
15
  ],
@@ -13,6 +13,7 @@ export const Opportunity: TableMetadata = {
13
13
  label: 'Opportunity',
14
14
  description: 'Represents an opportunity, which is a sale or pending deal.',
15
15
  metadataType: 'opportunity',
16
+ tasky: true,
16
17
  references: [
17
18
  'https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm',
18
19
  ],
@@ -9,6 +9,7 @@ exports.Organization = {
9
9
  label: 'Organization',
10
10
  description: 'Represents an organization, which is a company we are working with.',
11
11
  metadataType: 'organization',
12
+ tasky: false,
12
13
  references: [
13
14
  'https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm',
14
15
  ],
@@ -8,6 +8,7 @@ export const Organization: TableMetadata = {
8
8
  description:
9
9
  'Represents an organization, which is a company we are working with.',
10
10
  metadataType: 'organization',
11
+ tasky: false,
11
12
  references: [
12
13
  'https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm',
13
14
  ],
package/model.js CHANGED
@@ -4,7 +4,7 @@ exports.ConnectedProviderQL = exports.CredentialQL = exports.StandardObjectsQL =
4
4
  exports.BlockFieldsForUpsert = exports.BlockFields = exports.Person = exports.Organization = exports.Domain = exports.DomainQL = exports.Tenant = exports.TenantQL = exports.Recommendation = exports.RecommendationQL = exports.NotificationRecommendationQL = exports.ShareRecommendationQL = exports.UpsertRecommendationQL = exports.ConnectRecommendationQL = exports.TenantLight = exports.TenantLightQL = exports.TagRecommendationQL = exports.Tag = exports.TagQL = exports.TagFieldsJustSharing = exports.TagFieldsWithoutSharing = exports.GraphTagsInputQL = exports.GraphTagQL = exports.TagTypeQL = exports.Provider = exports.ProviderQL = exports.ProviderApplicationQL = exports.DashboardTagSubscriptionQL = exports.Sync = exports.SyncQL = exports.Search = exports.SearchQL = exports.Folder = exports.FolderQL = exports.History = exports.Metadata = exports.MetadataQL = exports.MetadataFields = exports.SharedPrimitive = exports.SharedPrimitiveFieldsForUpsert = exports.SharedPrimitiveFields = exports.Primitive = exports.PrimitiveFieldsForUpsert = exports.PrimitiveFields = exports.PersonReferenceQL = exports.PersonReferenceFields = exports.ChangesQL = exports.ChangesInputQL = exports.ReferenceBlockQL = exports.ReferenceBlockInputQL = void 0;
5
5
  exports.TableMetadataQL = exports.FieldValueQL = exports.FieldValueInputQL = exports.FieldQL = exports.OptionQL = exports.FieldVariation = exports.FieldType = exports.Template = exports.TemplateQL = exports.DashboardMetadata = exports.DashboardMetadataQL = exports.DocumentMetadata = exports.DocumentMetadataQL = exports.BlockDescriptionQL = exports.Website = exports.WebsiteQL = exports.Dashboard = exports.DashboardQL = exports.BlockDataQL = exports.Document = exports.DocumentQL = exports.DocumentFields = exports.Thread = exports.Todo = exports.Calendar = exports.CalendarQL = exports.Event = exports.EventQL = exports.PersonAcceptanceQL = exports.ResponseStatus = exports.EventStatus = exports.Conference = exports.ConferenceQL = exports.ConferenceEntrypointQL = exports.TranscriptionQL = exports.TranscriptionEntryQL = exports.Task = exports.TaskQL = exports.Note = exports.NoteQL = exports.Section = exports.BusinessObject = exports.BusinessObjectQL = exports.BusinessObjectFieldsForUpsert = exports.BusinessObjectFields = exports.BusinessObjectIngestionRequest = exports.BlockProcessingResponse = exports.BlockProcessingRequest = exports.Block = exports.BlockQL = void 0;
6
6
  exports.SearchTagsInputQL = exports.ArchiveSearchOutputQL = exports.ArchiveSearchInputQL = exports.FindSearchesInputQL = exports.FindSearchInputQL = exports.UpsertSearchInputQL = exports.ArchiveFolderOutputQL = exports.ArchiveFolderInputQL = exports.FindFoldersInputQL = exports.FindFolderInputQL = exports.UpsertFolderInputQL = exports.UpdateTaskInputQL = exports.DeleteSharingTagInputQL = exports.SetSharingTagInputQL = exports.MergeTagInputQL = exports.ArchiveTagOutputQL = exports.ArchiveTagInputQL = exports.FindTagsInputQL = exports.FindTagInputQL = exports.UpsertTagInputQL = exports.SharingTenantInputQL = exports.SharingDomainInputQL = exports.FindSyncInputQL = exports.FindProviderInputQL = exports.ArchiveRecommendationOutputQL = exports.ArchiveRecommendationInputQL = exports.UpdateRecommendationInputQL = exports.ArchiveBlockOutputQL = exports.ArchiveBlockInputQL = exports.FindBlocksInputQL = exports.FindBlockInputQL = exports.UpsertNoteInputQL = exports.FindDashboardInputQL = exports.UpsertDocumentInputQL = exports.FindDocumentInputQL = exports.FindEventInputQL = exports.FindCalendarInputQL = exports.FindDomainInputQL = exports.FindTenantsInputQL = exports.FindTenantInputQL = exports.UpsertRecordsInputQL = exports.FindRecordsInputQL = exports.FindRecordInputQL = exports.Table = exports.TableQL = exports.TableFields = exports.Record = exports.RecordQL = exports.RecordInputQL = exports.TableMetadata = void 0;
7
- exports.GraphQLTypes = exports.UpdateTagSharingInputQL = exports.GraphSearchEventsInputQL = exports.GraphSearchInputQL = exports.GraphSearchInputFields = exports.SortOptionInputQL = exports.BusinessObjectFilterInputQL = exports.StringFilterInputQL = exports.NumberFilterInputQL = exports.ChildItemQL = exports.ChildItemInputQL = exports.ChildItemFields = exports.ParentItemQL = exports.ParentItemInputQL = exports.ParentItemFields = exports.OrderDirection = exports.OrderDirectionQL = exports.TaskStatusQL = exports.BlockTypeQL = exports.SearchInputQL = void 0;
7
+ exports.GraphQLTypes = exports.UpdateTagSharingInputQL = exports.GraphSearchEventsInputQL = exports.GraphSearchInputQL = exports.GraphSearchInputFields = exports.SortOptionInputQL = exports.BusinessObjectFilterInputQL = exports.StringFilterInputQL = exports.NumberFilterInputQL = exports.ChildItemQL = exports.ChildItemInputQL = exports.ChildItemFields = exports.ParentItemQL = exports.ParentItemInputQL = exports.ParentItemFields = exports.OrderDirection = exports.OrderDirectionQL = exports.TaskStatusQL = exports.RecommendationTypeQL = exports.BlockTypeQL = exports.SearchInputQL = void 0;
8
8
  const uuid_1 = require("uuid");
9
9
  /*
10
10
  These are the core primitives of our model. These represent the entities that show
@@ -30,12 +30,14 @@ var BlockType;
30
30
  BlockType["Table"] = "table";
31
31
  BlockType["Folder"] = "folder";
32
32
  BlockType["Search"] = "search";
33
+ BlockType["Changeset"] = "changeset";
33
34
  })(BlockType || (exports.BlockType = BlockType = {}));
34
35
  var RecommendationType;
35
36
  (function (RecommendationType) {
36
37
  RecommendationType["Connect"] = "connect";
37
38
  RecommendationType["Upsert"] = "upsert";
38
39
  RecommendationType["Share"] = "share";
40
+ RecommendationType["Notification"] = "notification";
39
41
  })(RecommendationType || (exports.RecommendationType = RecommendationType = {}));
40
42
  var UpsertType;
41
43
  (function (UpsertType) {
@@ -1108,6 +1110,7 @@ exports.Document = Document;
1108
1110
  exports.BlockDataQL = `
1109
1111
  type BlockData {
1110
1112
  name: String!
1113
+ _ids: String
1111
1114
  blockType: String
1112
1115
  title: String
1113
1116
  document: String
@@ -1260,10 +1263,12 @@ type FieldValue {
1260
1263
  exports.TableMetadataQL = `
1261
1264
  type TableMetadata {${exports.MetadataFields}
1262
1265
  fields: [Field]!
1266
+ tasky: Boolean!
1263
1267
  }`;
1264
1268
  class TableMetadata extends Metadata {
1265
1269
  constructor(label, description, metadataType, fields, classifiers, threshold) {
1266
1270
  super(label, description, metadataType, classifiers, threshold);
1271
+ this.tasky = false;
1267
1272
  this.fields = fields;
1268
1273
  }
1269
1274
  }
@@ -1580,6 +1585,7 @@ input SearchTagsInput {
1580
1585
  exports.SearchInputQL = `
1581
1586
  input SearchInput {
1582
1587
  blockType: String
1588
+ recommendationType: String
1583
1589
  label: String
1584
1590
  search: String
1585
1591
  _ids: [String]
@@ -1621,6 +1627,13 @@ enum BlockType {
1621
1627
  ${BlockType.Todo.toUpperCase()}
1622
1628
  ${BlockType.Website.toUpperCase()}
1623
1629
  }`;
1630
+ exports.RecommendationTypeQL = `
1631
+ enum RecommendationType {
1632
+ ${RecommendationType.Connect.toUpperCase()}
1633
+ ${RecommendationType.Share.toUpperCase()}
1634
+ ${RecommendationType.Upsert.toUpperCase()}
1635
+ ${RecommendationType.Notification.toUpperCase()}
1636
+ }`;
1624
1637
  exports.TaskStatusQL = `
1625
1638
  enum TaskStatus {
1626
1639
  ${TaskStatus.Completed.toUpperCase()}
@@ -1692,6 +1705,7 @@ exports.GraphSearchInputFields = `
1692
1705
  _ids: [String]
1693
1706
  tenantIdCreateds: [String]
1694
1707
  tagIds: [String]
1708
+ recommendationTypes: [RecommendationType]
1695
1709
  blockTypes: [BlockType]
1696
1710
  statuses: [TaskStatus]
1697
1711
  businessObjects: [BusinessObjectFilterInput]
@@ -1849,6 +1863,7 @@ ${exports.SearchTagsInputQL}
1849
1863
  ${exports.SearchInputQL}
1850
1864
  ${exports.UpdateTagSharingInputQL}
1851
1865
  ${exports.BlockTypeQL}
1866
+ ${exports.RecommendationTypeQL}
1852
1867
  ${exports.TaskStatusQL}
1853
1868
  ${exports.OrderDirectionQL}
1854
1869
  ${exports.ParentItemQL}
package/model.ts CHANGED
@@ -23,12 +23,14 @@ export enum BlockType {
23
23
  Table = 'table',
24
24
  Folder = 'folder',
25
25
  Search = 'search',
26
+ Changeset = 'changeset',
26
27
  }
27
28
 
28
29
  export enum RecommendationType {
29
30
  Connect = 'connect',
30
31
  Upsert = 'upsert',
31
32
  Share = 'share',
33
+ Notification = 'notification',
32
34
  }
33
35
 
34
36
  export enum UpsertType {
@@ -1897,6 +1899,7 @@ export class Document extends BusinessObject {
1897
1899
  export const BlockDataQL = `
1898
1900
  type BlockData {
1899
1901
  name: String!
1902
+ _ids: String
1900
1903
  blockType: String
1901
1904
  title: String
1902
1905
  document: String
@@ -1906,6 +1909,7 @@ type BlockData {
1906
1909
  }`;
1907
1910
  export interface BlockData {
1908
1911
  name: string;
1912
+ _ids?: string[];
1909
1913
  blockType?: BlockType;
1910
1914
  title?: string;
1911
1915
  document?: string;
@@ -2186,9 +2190,11 @@ export interface FieldValue {
2186
2190
  export const TableMetadataQL = `
2187
2191
  type TableMetadata {${MetadataFields}
2188
2192
  fields: [Field]!
2193
+ tasky: Boolean!
2189
2194
  }`;
2190
2195
  export class TableMetadata extends Metadata {
2191
2196
  fields: Field[];
2197
+ tasky: boolean;
2192
2198
 
2193
2199
  constructor(
2194
2200
  label: string,
@@ -2200,6 +2206,7 @@ export class TableMetadata extends Metadata {
2200
2206
  ) {
2201
2207
  super(label, description, metadataType, classifiers, threshold);
2202
2208
 
2209
+ this.tasky = false;
2203
2210
  this.fields = fields;
2204
2211
  }
2205
2212
  }
@@ -2817,6 +2824,7 @@ export interface SearchTagsInput {
2817
2824
  export const SearchInputQL = `
2818
2825
  input SearchInput {
2819
2826
  blockType: String
2827
+ recommendationType: String
2820
2828
  label: String
2821
2829
  search: String
2822
2830
  _ids: [String]
@@ -2841,6 +2849,7 @@ input SearchInput {
2841
2849
  }`;
2842
2850
  export interface SearchInput {
2843
2851
  blockType?: BlockType;
2852
+ recommendationType?: RecommendationType;
2844
2853
  label?: string;
2845
2854
  search?: string;
2846
2855
  _ids?: string[];
@@ -2884,6 +2893,14 @@ enum BlockType {
2884
2893
  ${BlockType.Website.toUpperCase()}
2885
2894
  }`;
2886
2895
 
2896
+ export const RecommendationTypeQL = `
2897
+ enum RecommendationType {
2898
+ ${RecommendationType.Connect.toUpperCase()}
2899
+ ${RecommendationType.Share.toUpperCase()}
2900
+ ${RecommendationType.Upsert.toUpperCase()}
2901
+ ${RecommendationType.Notification.toUpperCase()}
2902
+ }`;
2903
+
2887
2904
  export const TaskStatusQL = `
2888
2905
  enum TaskStatus {
2889
2906
  ${TaskStatus.Completed.toUpperCase()}
@@ -2997,6 +3014,7 @@ export const GraphSearchInputFields = `
2997
3014
  _ids: [String]
2998
3015
  tenantIdCreateds: [String]
2999
3016
  tagIds: [String]
3017
+ recommendationTypes: [RecommendationType]
3000
3018
  blockTypes: [BlockType]
3001
3019
  statuses: [TaskStatus]
3002
3020
  businessObjects: [BusinessObjectFilterInput]
@@ -3025,6 +3043,7 @@ export interface GraphSearchInput {
3025
3043
  tenantIdCreateds?: string[];
3026
3044
  tagIds?: string[];
3027
3045
  blockTypes?: BlockType[];
3046
+ recommendationTypes?: RecommendationType[];
3028
3047
  statuses?: TaskStatus[];
3029
3048
  businessObjects?: BusinessObjectFilterInput[];
3030
3049
  originReferenceBlock?: ReferenceBlock;
@@ -3195,6 +3214,7 @@ ${SearchTagsInputQL}
3195
3214
  ${SearchInputQL}
3196
3215
  ${UpdateTagSharingInputQL}
3197
3216
  ${BlockTypeQL}
3217
+ ${RecommendationTypeQL}
3198
3218
  ${TaskStatusQL}
3199
3219
  ${OrderDirectionQL}
3200
3220
  ${ParentItemQL}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "Bigfoot",
3
3
  "name": "@bigfootai/bigfoot-types",
4
- "version": "5.1.30",
4
+ "version": "5.1.32",
5
5
  "description": "The internal library for the types used in the Bigfoot platform",
6
6
  "main": "model.js",
7
7
  "license": "ISC",