@sprucelabs/mercury-types 46.0.299 → 47.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 (37) hide show
  1. package/build/.spruce/errors/errors.types.js +0 -2
  2. package/build/.spruce/errors/mercury/invalidEventContract.schema.js +1 -1
  3. package/build/.spruce/errors/options.types.d.ts +2 -2
  4. package/build/.spruce/schemas/fields/fields.types.d.ts +1 -1
  5. package/build/.spruce/schemas/mercury/v2020_12_25/eventContract.schema.js +6 -6
  6. package/build/.spruce/schemas/mercury/v2020_12_25/eventSignature.schema.js +18 -18
  7. package/build/.spruce/schemas/mercury/v2020_12_25/eventSignaturesByName.schema.js +1 -1
  8. package/build/.spruce/schemas/mercury/v2020_12_25/feedOptions.schema.js +9 -9
  9. package/build/.spruce/schemas/mercury/v2020_12_25/permission.schema.js +13 -13
  10. package/build/.spruce/schemas/mercury/v2020_12_25/permissionContract.schema.js +12 -12
  11. package/build/.spruce/schemas/mercury/v2020_12_25/permissionDefaults.schema.js +17 -17
  12. package/build/.spruce/schemas/mercury/v2020_12_25/permissionReference.schema.js +8 -6
  13. package/build/.spruce/schemas/mercury/v2020_12_25/statusFlags.schema.js +12 -12
  14. package/build/.spruce/schemas/schemas.types.d.ts +87 -88
  15. package/build/.spruce/schemas/schemas.types.js +0 -2
  16. package/build/errors/SpruceError.d.ts +1 -1
  17. package/build/errors/SpruceError.js +2 -2
  18. package/build/esm/.spruce/errors/errors.types.js +0 -2
  19. package/build/esm/.spruce/errors/options.types.d.ts +2 -2
  20. package/build/esm/.spruce/schemas/mercury/v2020_12_25/eventContract.schema.js +6 -6
  21. package/build/esm/.spruce/schemas/mercury/v2020_12_25/eventSignature.schema.js +18 -18
  22. package/build/esm/.spruce/schemas/mercury/v2020_12_25/eventSignaturesByName.schema.js +1 -1
  23. package/build/esm/.spruce/schemas/mercury/v2020_12_25/feedOptions.schema.js +9 -9
  24. package/build/esm/.spruce/schemas/mercury/v2020_12_25/permission.schema.js +13 -13
  25. package/build/esm/.spruce/schemas/mercury/v2020_12_25/permissionContract.schema.js +12 -12
  26. package/build/esm/.spruce/schemas/mercury/v2020_12_25/permissionDefaults.schema.js +17 -17
  27. package/build/esm/.spruce/schemas/mercury/v2020_12_25/permissionReference.schema.js +8 -6
  28. package/build/esm/.spruce/schemas/mercury/v2020_12_25/statusFlags.schema.js +12 -12
  29. package/build/esm/.spruce/schemas/schemas.types.d.ts +87 -88
  30. package/build/esm/.spruce/schemas/schemas.types.js +0 -2
  31. package/build/esm/errors/SpruceError.d.ts +1 -1
  32. package/build/esm/schemas/v2020_12_25/eventContract.builder.js +6 -2
  33. package/build/esm/types/mercury.types.d.ts +2 -4
  34. package/build/schemas/v2020_12_25/eventContract.builder.js +6 -2
  35. package/build/schemas/v2020_12_25/permissionContract.builder.js +25 -29
  36. package/build/types/mercury.types.d.ts +2 -4
  37. package/package.json +15 -15
@@ -1,4 +1,2 @@
1
1
  "use strict";
2
- /* eslint-disable @typescript-eslint/no-namespace */
3
- /* eslint-disable no-redeclare */
4
2
  Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,7 +5,7 @@ const invalidEventContractSchema = {
5
5
  id: 'invalidEventContract',
6
6
  namespace: 'Mercury',
7
7
  name: 'Invalid event contract',
8
- fields: {}
8
+ fields: {},
9
9
  };
10
10
  schema_1.SchemaRegistry.getInstance().trackSchema(invalidEventContractSchema);
11
11
  exports.default = invalidEventContractSchema;
@@ -1,5 +1,5 @@
1
- import { SpruceErrors } from "./errors.types";
2
- import { ErrorOptions as ISpruceErrorOptions } from "@sprucelabs/error";
1
+ import { ErrorOptions as ISpruceErrorOptions } from '@sprucelabs/error';
2
+ import { SpruceErrors } from './errors.types';
3
3
  export interface InvalidEventContractErrorOptions extends SpruceErrors.Mercury.InvalidEventContract, ISpruceErrorOptions {
4
4
  code: 'INVALID_EVENT_CONTRACT';
5
5
  }
@@ -1 +1 @@
1
- export { FieldDefinitions, FieldDefinitionMap, FieldValueTypeGeneratorMap, FieldMap } from '@sprucelabs/schema';
1
+ export { FieldDefinitions, FieldDefinitionMap, FieldValueTypeGeneratorMap, FieldMap, } from '@sprucelabs/schema';
@@ -10,22 +10,22 @@ const eventContractSchema = {
10
10
  version: 'v2020_12_25',
11
11
  namespace: 'Mercury',
12
12
  name: 'Event contract',
13
- importsWhenRemote: ['import \'@sprucelabs/mercury-types\'',],
13
+ importsWhenRemote: ["import '@sprucelabs/mercury-types'"],
14
14
  moduleToImportFromWhenRemote: '@sprucelabs/mercury-types',
15
15
  description: 'A Mercury Event Contract.',
16
16
  fields: {
17
17
  /** . */
18
- 'id': {
18
+ id: {
19
19
  type: 'id',
20
- options: undefined
20
+ options: undefined,
21
21
  },
22
22
  /** . */
23
- 'eventSignatures': {
23
+ eventSignatures: {
24
24
  type: 'schema',
25
25
  isRequired: true,
26
- options: { schema: eventSignaturesByName_schema_1.default, }
26
+ options: { schema: eventSignaturesByName_schema_1.default },
27
27
  },
28
- }
28
+ },
29
29
  };
30
30
  schema_1.SchemaRegistry.getInstance().trackSchema(eventContractSchema);
31
31
  exports.default = eventContractSchema;
@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  const schema_1 = require("@sprucelabs/schema");
7
7
  const feedOptions_schema_1 = __importDefault(require("./feedOptions.schema"));
8
- const permissionReference_schema_1 = __importDefault(require("./permissionReference.schema"));
9
8
  const permissionContract_schema_1 = __importDefault(require("./permissionContract.schema"));
9
+ const permissionReference_schema_1 = __importDefault(require("./permissionReference.schema"));
10
10
  const eventSignatureSchema = {
11
11
  id: 'eventSignature',
12
12
  version: 'v2020_12_25',
@@ -15,47 +15,47 @@ const eventSignatureSchema = {
15
15
  moduleToImportFromWhenRemote: '@sprucelabs/mercury-types',
16
16
  fields: {
17
17
  /** . */
18
- 'isGlobal': {
18
+ isGlobal: {
19
19
  type: 'boolean',
20
20
  defaultValue: false,
21
- options: undefined
21
+ options: undefined,
22
22
  },
23
23
  /** . */
24
- 'responsePayloadSchema': {
24
+ responsePayloadSchema: {
25
25
  type: 'raw',
26
- options: { valueType: `SpruceSchema.Schema`, }
26
+ options: { valueType: `SpruceSchema.Schema` },
27
27
  },
28
28
  /** . */
29
- 'emitPayloadSchema': {
29
+ emitPayloadSchema: {
30
30
  type: 'raw',
31
- options: { valueType: `SpruceSchema.Schema`, }
31
+ options: { valueType: `SpruceSchema.Schema` },
32
32
  },
33
33
  /** . */
34
- 'feed': {
34
+ feed: {
35
35
  type: 'schema',
36
- options: { schema: feedOptions_schema_1.default, }
36
+ options: { schema: feedOptions_schema_1.default },
37
37
  },
38
38
  /** . */
39
- 'listenPermissions': {
39
+ listenPermissions: {
40
40
  type: 'schema',
41
- options: { schema: permissionReference_schema_1.default, }
41
+ options: { schema: permissionReference_schema_1.default },
42
42
  },
43
43
  /** . */
44
- 'emitPermissions': {
44
+ emitPermissions: {
45
45
  type: 'schema',
46
- options: { schema: permissionReference_schema_1.default, }
46
+ options: { schema: permissionReference_schema_1.default },
47
47
  },
48
48
  /** . */
49
- 'listenPermissionContract': {
49
+ listenPermissionContract: {
50
50
  type: 'schema',
51
- options: { schema: permissionContract_schema_1.default, }
51
+ options: { schema: permissionContract_schema_1.default },
52
52
  },
53
53
  /** . */
54
- 'emitPermissionContract': {
54
+ emitPermissionContract: {
55
55
  type: 'schema',
56
- options: { schema: permissionContract_schema_1.default, }
56
+ options: { schema: permissionContract_schema_1.default },
57
57
  },
58
- }
58
+ },
59
59
  };
60
60
  schema_1.SchemaRegistry.getInstance().trackSchema(eventSignatureSchema);
61
61
  exports.default = eventSignatureSchema;
@@ -15,7 +15,7 @@ const eventSignaturesByNameSchema = {
15
15
  type: 'schema',
16
16
  keyName: 'eventName',
17
17
  isRequired: true,
18
- options: { schema: eventSignature_schema_1.default, }
18
+ options: { schema: eventSignature_schema_1.default },
19
19
  },
20
20
  };
21
21
  schema_1.SchemaRegistry.getInstance().trackSchema(eventSignaturesByNameSchema);
@@ -9,31 +9,31 @@ const feedOptionsSchema = {
9
9
  moduleToImportFromWhenRemote: '@sprucelabs/mercury-types',
10
10
  fields: {
11
11
  /** . A handlebarsjs template used to render the chat bubbles in the feed. You will have both the entire target and payload available to you in the template. See http://developer.spruce.bot for more details. */
12
- 'template': {
12
+ template: {
13
13
  type: 'text',
14
14
  hint: 'A handlebarsjs template used to render the chat bubbles in the feed. You will have both the entire target and payload available to you in the template. See http://developer.spruce.bot for more details.',
15
- options: undefined
15
+ options: undefined,
16
16
  },
17
17
  /** . */
18
- 'pathsToLinks': {
18
+ pathsToLinks: {
19
19
  type: 'text',
20
20
  isArray: true,
21
21
  minArrayLength: 0,
22
- options: undefined
22
+ options: undefined,
23
23
  },
24
24
  /** . */
25
- 'pathsToChoices': {
25
+ pathsToChoices: {
26
26
  type: 'text',
27
27
  isArray: true,
28
28
  minArrayLength: 0,
29
- options: undefined
29
+ options: undefined,
30
30
  },
31
31
  /** . */
32
- 'pathToContext': {
32
+ pathToContext: {
33
33
  type: 'text',
34
- options: undefined
34
+ options: undefined,
35
35
  },
36
- }
36
+ },
37
37
  };
38
38
  schema_1.SchemaRegistry.getInstance().trackSchema(feedOptionsSchema);
39
39
  exports.default = feedOptionsSchema;
@@ -14,45 +14,45 @@ const permissionSchema = {
14
14
  moduleToImportFromWhenRemote: '@sprucelabs/mercury-types',
15
15
  fields: {
16
16
  /** id. Hyphen separated id for this permission, e.g. can-unlock-doors */
17
- 'id': {
17
+ id: {
18
18
  label: 'id',
19
19
  type: 'text',
20
20
  isRequired: true,
21
21
  hint: 'Hyphen separated id for this permission, e.g. can-unlock-doors',
22
- options: undefined
22
+ options: undefined,
23
23
  },
24
24
  /** Name. Human readable name for this permission */
25
- 'name': {
25
+ name: {
26
26
  label: 'Name',
27
27
  type: 'text',
28
28
  isRequired: true,
29
29
  hint: 'Human readable name for this permission',
30
- options: undefined
30
+ options: undefined,
31
31
  },
32
32
  /** Description. */
33
- 'description': {
33
+ description: {
34
34
  label: 'Description',
35
35
  type: 'text',
36
- options: undefined
36
+ options: undefined,
37
37
  },
38
38
  /** Require all statuses. */
39
- 'requireAllStatuses': {
39
+ requireAllStatuses: {
40
40
  label: 'Require all statuses',
41
41
  type: 'boolean',
42
42
  defaultValue: false,
43
- options: undefined
43
+ options: undefined,
44
44
  },
45
45
  /** . */
46
- 'defaults': {
46
+ defaults: {
47
47
  type: 'schema',
48
- options: { schema: permissionDefaults_schema_1.default, }
48
+ options: { schema: permissionDefaults_schema_1.default },
49
49
  },
50
50
  /** . */
51
- 'can': {
51
+ can: {
52
52
  type: 'schema',
53
- options: { schema: statusFlags_schema_1.default, }
53
+ options: { schema: statusFlags_schema_1.default },
54
54
  },
55
- }
55
+ },
56
56
  };
57
57
  schema_1.SchemaRegistry.getInstance().trackSchema(permissionSchema);
58
58
  exports.default = permissionSchema;
@@ -10,46 +10,46 @@ const permissionContractSchema = {
10
10
  version: 'v2020_12_25',
11
11
  namespace: 'Mercury',
12
12
  name: 'Permission contract',
13
- importsWhenRemote: ['import \'@sprucelabs/mercury-types\'',],
13
+ importsWhenRemote: ["import '@sprucelabs/mercury-types'"],
14
14
  moduleToImportFromWhenRemote: '@sprucelabs/mercury-types',
15
15
  description: 'A Mercury Permission Contract',
16
16
  fields: {
17
17
  /** . */
18
- 'id': {
18
+ id: {
19
19
  type: 'text',
20
20
  isRequired: true,
21
- options: undefined
21
+ options: undefined,
22
22
  },
23
23
  /** Name. Human readable name for this contract */
24
- 'name': {
24
+ name: {
25
25
  label: 'Name',
26
26
  type: 'text',
27
27
  isRequired: true,
28
28
  hint: 'Human readable name for this contract',
29
- options: undefined
29
+ options: undefined,
30
30
  },
31
31
  /** Description. */
32
- 'description': {
32
+ description: {
33
33
  label: 'Description',
34
34
  type: 'text',
35
- options: undefined
35
+ options: undefined,
36
36
  },
37
37
  /** Require all permissions. */
38
- 'requireAllPermissions': {
38
+ requireAllPermissions: {
39
39
  label: 'Require all permissions',
40
40
  type: 'boolean',
41
41
  defaultValue: false,
42
- options: undefined
42
+ options: undefined,
43
43
  },
44
44
  /** . */
45
- 'permissions': {
45
+ permissions: {
46
46
  type: 'schema',
47
47
  isRequired: true,
48
48
  isArray: true,
49
49
  minArrayLength: 0,
50
- options: { schema: permission_schema_1.default, }
50
+ options: { schema: permission_schema_1.default },
51
51
  },
52
- }
52
+ },
53
53
  };
54
54
  schema_1.SchemaRegistry.getInstance().trackSchema(permissionContractSchema);
55
55
  exports.default = permissionContractSchema;
@@ -13,53 +13,53 @@ const permissionDefaultsSchema = {
13
13
  moduleToImportFromWhenRemote: '@sprucelabs/mercury-types',
14
14
  fields: {
15
15
  /** . */
16
- 'skill': {
16
+ skill: {
17
17
  type: 'boolean',
18
- options: undefined
18
+ options: undefined,
19
19
  },
20
20
  /** Owner. */
21
- 'owner': {
21
+ owner: {
22
22
  label: 'Owner',
23
23
  type: 'schema',
24
- options: { schema: statusFlags_schema_1.default, }
24
+ options: { schema: statusFlags_schema_1.default },
25
25
  },
26
26
  /** Group manager. */
27
- 'groupManager': {
27
+ groupManager: {
28
28
  label: 'Group manager',
29
29
  type: 'schema',
30
- options: { schema: statusFlags_schema_1.default, }
30
+ options: { schema: statusFlags_schema_1.default },
31
31
  },
32
32
  /** Manager. */
33
- 'manager': {
33
+ manager: {
34
34
  label: 'Manager',
35
35
  type: 'schema',
36
- options: { schema: statusFlags_schema_1.default, }
36
+ options: { schema: statusFlags_schema_1.default },
37
37
  },
38
38
  /** Teammate. */
39
- 'teammate': {
39
+ teammate: {
40
40
  label: 'Teammate',
41
41
  type: 'schema',
42
- options: { schema: statusFlags_schema_1.default, }
42
+ options: { schema: statusFlags_schema_1.default },
43
43
  },
44
44
  /** Anonymous. */
45
- 'anonymous': {
45
+ anonymous: {
46
46
  label: 'Anonymous',
47
47
  type: 'schema',
48
- options: { schema: statusFlags_schema_1.default, }
48
+ options: { schema: statusFlags_schema_1.default },
49
49
  },
50
50
  /** Logged in. */
51
- 'loggedIn': {
51
+ loggedIn: {
52
52
  label: 'Logged in',
53
53
  type: 'schema',
54
- options: { schema: statusFlags_schema_1.default, }
54
+ options: { schema: statusFlags_schema_1.default },
55
55
  },
56
56
  /** Guest. */
57
- 'guest': {
57
+ guest: {
58
58
  label: 'Guest',
59
59
  type: 'schema',
60
- options: { schema: statusFlags_schema_1.default, }
60
+ options: { schema: statusFlags_schema_1.default },
61
61
  },
62
- }
62
+ },
63
63
  };
64
64
  schema_1.SchemaRegistry.getInstance().trackSchema(permissionDefaultsSchema);
65
65
  exports.default = permissionDefaultsSchema;
@@ -6,23 +6,25 @@ const permissionReferenceSchema = {
6
6
  version: 'v2020_12_25',
7
7
  namespace: 'Mercury',
8
8
  name: '',
9
- importsWhenRemote: ['import * as MercuryTypes from \'@sprucelabs/mercury-types\'',],
9
+ importsWhenRemote: [
10
+ "import * as MercuryTypes from '@sprucelabs/mercury-types'",
11
+ ],
10
12
  moduleToImportFromWhenRemote: '@sprucelabs/mercury-types',
11
13
  typeSuffix: '<ContractId extends MercuryTypes.PermissionContractId = MercuryTypes.PermissionContractId>',
12
14
  fields: {
13
15
  /** . */
14
- 'contractId': {
16
+ contractId: {
15
17
  type: 'raw',
16
18
  isRequired: true,
17
- options: { valueType: `ContractId`, }
19
+ options: { valueType: `ContractId` },
18
20
  },
19
21
  /** . */
20
- 'permissionIdsAny': {
22
+ permissionIdsAny: {
21
23
  type: 'raw',
22
24
  isArray: true,
23
- options: { valueType: `MercuryTypes.PermissionId<ContractId>`, }
25
+ options: { valueType: `MercuryTypes.PermissionId<ContractId>` },
24
26
  },
25
- }
27
+ },
26
28
  };
27
29
  schema_1.SchemaRegistry.getInstance().trackSchema(permissionReferenceSchema);
28
30
  exports.default = permissionReferenceSchema;
@@ -9,40 +9,40 @@ const statusFlagsSchema = {
9
9
  moduleToImportFromWhenRemote: '@sprucelabs/mercury-types',
10
10
  fields: {
11
11
  /** . What is the fallback if no status is set? */
12
- 'default': {
12
+ default: {
13
13
  type: 'boolean',
14
14
  hint: 'What is the fallback if no status is set?',
15
- options: undefined
15
+ options: undefined,
16
16
  },
17
17
  /** Clocked in. Is the person clocked in and ready to rock? */
18
- 'clockedIn': {
18
+ clockedIn: {
19
19
  label: 'Clocked in',
20
20
  type: 'boolean',
21
21
  hint: 'Is the person clocked in and ready to rock?',
22
- options: undefined
22
+ options: undefined,
23
23
  },
24
24
  /** Clocked out. When someone is not working (off the clock). */
25
- 'clockedOut': {
25
+ clockedOut: {
26
26
  label: 'Clocked out',
27
27
  type: 'boolean',
28
28
  hint: 'When someone is not working (off the clock).',
29
- options: undefined
29
+ options: undefined,
30
30
  },
31
31
  /** On premises. Are they at work (maybe working, maybe visiting). */
32
- 'onPrem': {
32
+ onPrem: {
33
33
  label: 'On premises',
34
34
  type: 'boolean',
35
35
  hint: 'Are they at work (maybe working, maybe visiting).',
36
- options: undefined
36
+ options: undefined,
37
37
  },
38
38
  /** Off premises. They aren't at the office or shop. */
39
- 'offPrem': {
39
+ offPrem: {
40
40
  label: 'Off premises',
41
41
  type: 'boolean',
42
- hint: 'They aren\'t at the office or shop.',
43
- options: undefined
42
+ hint: "They aren't at the office or shop.",
43
+ options: undefined,
44
44
  },
45
- }
45
+ },
46
46
  };
47
47
  schema_1.SchemaRegistry.getInstance().trackSchema(statusFlagsSchema);
48
48
  exports.default = statusFlagsSchema;