lucid-extension-sdk 0.0.420 → 0.0.421

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.
@@ -7,10 +7,10 @@ import { LucidFields } from './fieldtypedefinition/lucidfields';
7
7
  import { ScalarFieldTypeEnum } from './fieldtypedefinition/scalarfieldtype';
8
8
  import { SemanticFields } from './fieldtypedefinition/semanticfields';
9
9
  import { SemanticKind } from './fieldtypedefinition/semantickind';
10
- import { SerializedColorObject, SerializedLucidCurrency, SerializedLucidDateObject, SerializedLucidDictionary } from './serializedfield/serializedfields';
10
+ import { SerializedColorObject, SerializedLucidCurrency, SerializedLucidDateObject, SerializedLucidDateRangeObject, SerializedLucidDictionary } from './serializedfield/serializedfields';
11
11
  type TsTypeOf<X> = X extends ScalarFieldTypeEnum.ANY ? unknown : X extends ScalarFieldTypeEnum.NUMBER ? number : X extends ScalarFieldTypeEnum.BOOLEAN ? boolean : X extends ScalarFieldTypeEnum.STRING ? string : X extends ScalarFieldTypeEnum.COLOR ? SerializedColorObject : X extends ScalarFieldTypeEnum.DATE ? SerializedLucidDateObject : X extends ScalarFieldTypeEnum.NULL ? null : X extends ScalarFieldTypeEnum.DICTIONARY ? SerializedLucidDictionary : X extends FieldTypeArray<infer Inner> ? TsTypeOf<Inner>[] : X extends ScalarFieldTypeEnum.CURRENCY ? SerializedLucidCurrency : X extends ScalarFieldTypeEnum.DATEONLY ? SerializedLucidDateObject & {
12
12
  isDateOnly: true;
13
- } : X extends CollectionEnumFieldType ? string : X extends DeserializedMapEnumFieldType ? string : X extends readonly [infer Inner, ...infer Others] ? TsTypeOf<Inner> | TsTypeOf<Others> : never;
13
+ } : X extends ScalarFieldTypeEnum.DATERANGE ? SerializedLucidDateRangeObject : X extends CollectionEnumFieldType ? string : X extends DeserializedMapEnumFieldType ? string : X extends readonly [infer Inner, ...infer Others] ? TsTypeOf<Inner> | TsTypeOf<Others> : never;
14
14
  /**
15
15
  * Specifies all the fields that this itegration will be sending to the data-sync service.
16
16
  * Give you well typed methods to convert from `YourType[]` to `{[PrimaryKey:string]: YourType}`
@@ -9,7 +9,8 @@ export declare enum ScalarFieldTypeEnum {
9
9
  DICTIONARY = 7,
10
10
  CURRENCY = 8,
11
11
  DATEONLY = 9,
12
- TIMEONLY = 10
12
+ TIMEONLY = 10,
13
+ DATERANGE = 11
13
14
  }
14
15
  export declare const AnyScalarFieldType: ScalarFieldTypeEnum[];
15
16
  export declare const isScalarFieldTypeEnum: (fieldType: any) => fieldType is ScalarFieldTypeEnum;
@@ -14,6 +14,7 @@ var ScalarFieldTypeEnum;
14
14
  ScalarFieldTypeEnum[ScalarFieldTypeEnum["CURRENCY"] = 8] = "CURRENCY";
15
15
  ScalarFieldTypeEnum[ScalarFieldTypeEnum["DATEONLY"] = 9] = "DATEONLY";
16
16
  ScalarFieldTypeEnum[ScalarFieldTypeEnum["TIMEONLY"] = 10] = "TIMEONLY";
17
+ ScalarFieldTypeEnum[ScalarFieldTypeEnum["DATERANGE"] = 11] = "DATERANGE";
17
18
  })(ScalarFieldTypeEnum || (exports.ScalarFieldTypeEnum = ScalarFieldTypeEnum = {}));
18
19
  exports.AnyScalarFieldType = [
19
20
  ScalarFieldTypeEnum.ANY,
@@ -27,6 +28,7 @@ exports.AnyScalarFieldType = [
27
28
  ScalarFieldTypeEnum.DICTIONARY,
28
29
  ScalarFieldTypeEnum.CURRENCY,
29
30
  ScalarFieldTypeEnum.TIMEONLY,
31
+ ScalarFieldTypeEnum.DATERANGE,
30
32
  ];
31
33
  const AnyScalarFieldTypeSet = new Set(exports.AnyScalarFieldType);
32
34
  const isScalarFieldTypeEnum = (fieldType) => {
@@ -1,5 +1,5 @@
1
1
  import { isNumber, isString } from '../../checks';
2
- export type SerializedFieldType = number | boolean | string | null | SerializedLucidDateObject | SerializedTimeObject | SerializedColorObjectFieldType | SerializedLucidDictionary | SerializedLucidCurrency | undefined | Array<SerializedFieldType>;
2
+ export type SerializedFieldType = number | boolean | string | null | SerializedLucidDateObject | SerializedLucidDateRangeObject | SerializedTimeObject | SerializedColorObjectFieldType | SerializedLucidDictionary | SerializedLucidCurrency | undefined | Array<SerializedFieldType>;
3
3
  export type SerializedJsonFieldType = number | boolean | string | null | undefined | Array<SerializedJsonFieldType> | {
4
4
  [index: string]: SerializedJsonFieldType;
5
5
  };
@@ -30,6 +30,10 @@ export type SerializedMillisecondsDateObject = {
30
30
  'isDateOnly'?: boolean;
31
31
  };
32
32
  export type SerializedLucidDateObject = SerializedMillisecondsDateObject | SerializedIsoDateObject;
33
+ export type SerializedLucidDateRangeObject = {
34
+ 'startDate': SerializedLucidDateObject;
35
+ 'endDate': SerializedLucidDateObject;
36
+ };
33
37
  export type SerializedTimeObject = {
34
38
  'hours': number;
35
39
  'minutes'?: number | undefined;
@@ -114,6 +118,22 @@ export declare const isSerializedLucidDateObject: (x: unknown) => x is import(".
114
118
  isoDate: typeof isString;
115
119
  displayTimezone: (x: unknown) => x is string | null | undefined;
116
120
  }>;
121
+ export declare const isSerializedLucidDateRangeObject: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
122
+ startDate: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
123
+ ms: typeof isNumber;
124
+ isDateOnly: (x: unknown) => x is boolean | undefined;
125
+ }> | import("../../guards").DestructureGuardedTypeObj<{
126
+ isoDate: typeof isString;
127
+ displayTimezone: (x: unknown) => x is string | null | undefined;
128
+ }>;
129
+ endDate: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
130
+ ms: typeof isNumber;
131
+ isDateOnly: (x: unknown) => x is boolean | undefined;
132
+ }> | import("../../guards").DestructureGuardedTypeObj<{
133
+ isoDate: typeof isString;
134
+ displayTimezone: (x: unknown) => x is string | null | undefined;
135
+ }>;
136
+ }>;
117
137
  export declare const isSerializedTimeObject: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
118
138
  hours: typeof isNumber;
119
139
  minutes: (x: unknown) => x is number | undefined;
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.isSerializedFields = exports.isSerializedJsonFieldType = exports.isSerializedFieldType = exports.isSerializedLucidIconDataDictionary = exports.isSerializedTimeObject = exports.isSerializedLucidDateObject = exports.isSerializedIsoDateObject = exports.isSerializedMillisecondsDateObject = exports.isSerializedLucidAvatarDataDictionary = exports.isSerializedLucidCurrency = exports.isSerializedLucidDictionary = exports.isJsonSerializedLucidDictionary = exports.isNestedSerializedLucidDictionary = exports.isSerializedColorObjectFieldType = void 0;
3
+ exports.isSerializedFields = exports.isSerializedJsonFieldType = exports.isSerializedFieldType = exports.isSerializedLucidIconDataDictionary = exports.isSerializedTimeObject = exports.isSerializedLucidDateRangeObject = exports.isSerializedLucidDateObject = exports.isSerializedIsoDateObject = exports.isSerializedMillisecondsDateObject = exports.isSerializedLucidAvatarDataDictionary = exports.isSerializedLucidCurrency = exports.isSerializedLucidDictionary = exports.isJsonSerializedLucidDictionary = exports.isNestedSerializedLucidDictionary = exports.isSerializedColorObjectFieldType = void 0;
4
4
  const checks_1 = require("../../checks");
5
5
  const validators_1 = require("../../validators/validators");
6
6
  function isSerializedColorObjectFieldType(value) {
@@ -35,6 +35,10 @@ exports.isSerializedIsoDateObject = (0, validators_1.objectValidator)({
35
35
  'displayTimezone': (0, validators_1.nullableOption)(checks_1.isString),
36
36
  });
37
37
  exports.isSerializedLucidDateObject = (0, validators_1.either)(exports.isSerializedMillisecondsDateObject, exports.isSerializedIsoDateObject);
38
+ exports.isSerializedLucidDateRangeObject = (0, validators_1.objectValidator)({
39
+ 'startDate': exports.isSerializedLucidDateObject,
40
+ 'endDate': exports.isSerializedLucidDateObject,
41
+ });
38
42
  exports.isSerializedTimeObject = (0, validators_1.objectValidator)({
39
43
  'hours': checks_1.isNumber,
40
44
  'minutes': (0, validators_1.option)(checks_1.isNumber),
@@ -56,6 +60,7 @@ function isSerializedFieldType(value) {
56
60
  (0, exports.isSerializedLucidCurrency)(value) ||
57
61
  ((0, checks_1.isArray)(value) && value.every(isSerializedFieldType)) ||
58
62
  (0, exports.isSerializedLucidDateObject)(value) ||
63
+ (0, exports.isSerializedLucidDateRangeObject)(value) ||
59
64
  (0, exports.isSerializedTimeObject)(value) ||
60
65
  isSerializedColorObjectFieldType(value) ||
61
66
  (0, exports.isSerializedLucidIconDataDictionary)(value) ||
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "lucid-extension-sdk",
3
- "version": "0.0.420",
3
+ "version": "0.0.421",
4
4
  "description": "Utility classes for writing Lucid Software editor extensions",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",