@fluid-experimental/property-common 0.49.0 → 0.50.0-41540

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 (130) hide show
  1. package/dist/constants.d.ts +4 -0
  2. package/dist/constants.d.ts.map +1 -1
  3. package/dist/constants.js +4 -0
  4. package/dist/constants.js.map +1 -1
  5. package/dist/packageVersion.d.ts +1 -1
  6. package/dist/packageVersion.d.ts.map +1 -1
  7. package/dist/packageVersion.js +1 -1
  8. package/dist/packageVersion.js.map +1 -1
  9. package/lib/chronometer.d.ts +55 -0
  10. package/lib/chronometer.d.ts.map +1 -0
  11. package/lib/chronometer.js +185 -0
  12. package/lib/chronometer.js.map +1 -0
  13. package/lib/consoleUtils.d.ts +16 -0
  14. package/lib/consoleUtils.d.ts.map +1 -0
  15. package/lib/consoleUtils.js +20 -0
  16. package/lib/consoleUtils.js.map +1 -0
  17. package/lib/constants.d.ts +1219 -0
  18. package/lib/constants.d.ts.map +1 -0
  19. package/lib/constants.js +1274 -0
  20. package/lib/constants.js.map +1 -0
  21. package/lib/datastructures/collection.d.ts +203 -0
  22. package/lib/datastructures/collection.d.ts.map +1 -0
  23. package/lib/datastructures/collection.js +377 -0
  24. package/lib/datastructures/collection.js.map +1 -0
  25. package/lib/datastructures/dataArray.d.ts +275 -0
  26. package/lib/datastructures/dataArray.d.ts.map +1 -0
  27. package/lib/datastructures/dataArray.js +497 -0
  28. package/lib/datastructures/dataArray.js.map +1 -0
  29. package/lib/datastructures/index.d.ts +9 -0
  30. package/lib/datastructures/index.d.ts.map +1 -0
  31. package/lib/datastructures/index.js +9 -0
  32. package/lib/datastructures/index.js.map +1 -0
  33. package/lib/datastructures/integer64.d.ts +47 -0
  34. package/lib/datastructures/integer64.d.ts.map +1 -0
  35. package/lib/datastructures/integer64.js +140 -0
  36. package/lib/datastructures/integer64.js.map +1 -0
  37. package/lib/datastructures/sortedCollection.d.ts +77 -0
  38. package/lib/datastructures/sortedCollection.d.ts.map +1 -0
  39. package/lib/datastructures/sortedCollection.js +140 -0
  40. package/lib/datastructures/sortedCollection.js.map +1 -0
  41. package/lib/deferredPromise.d.ts +28 -0
  42. package/lib/deferredPromise.d.ts.map +1 -0
  43. package/lib/deferredPromise.js +43 -0
  44. package/lib/deferredPromise.js.map +1 -0
  45. package/lib/deterministicRandomGenerator.d.ts +39 -0
  46. package/lib/deterministicRandomGenerator.d.ts.map +1 -0
  47. package/lib/deterministicRandomGenerator.js +83 -0
  48. package/lib/deterministicRandomGenerator.js.map +1 -0
  49. package/lib/error_objects/flaggedError.d.ts +29 -0
  50. package/lib/error_objects/flaggedError.d.ts.map +1 -0
  51. package/lib/error_objects/flaggedError.js +45 -0
  52. package/lib/error_objects/flaggedError.js.map +1 -0
  53. package/lib/error_objects/httpError.d.ts +31 -0
  54. package/lib/error_objects/httpError.d.ts.map +1 -0
  55. package/lib/error_objects/httpError.js +58 -0
  56. package/lib/error_objects/httpError.js.map +1 -0
  57. package/lib/error_objects/httpErrorNoStack.d.ts +25 -0
  58. package/lib/error_objects/httpErrorNoStack.d.ts.map +1 -0
  59. package/lib/error_objects/httpErrorNoStack.js +29 -0
  60. package/lib/error_objects/httpErrorNoStack.js.map +1 -0
  61. package/lib/error_objects/index.d.ts +9 -0
  62. package/lib/error_objects/index.d.ts.map +1 -0
  63. package/lib/error_objects/index.js +9 -0
  64. package/lib/error_objects/index.js.map +1 -0
  65. package/lib/error_objects/operationError.d.ts +32 -0
  66. package/lib/error_objects/operationError.d.ts.map +1 -0
  67. package/lib/error_objects/operationError.js +73 -0
  68. package/lib/error_objects/operationError.js.map +1 -0
  69. package/lib/guidUtils.d.ts +16 -0
  70. package/lib/guidUtils.d.ts.map +1 -0
  71. package/lib/guidUtils.js +297 -0
  72. package/lib/guidUtils.js.map +1 -0
  73. package/lib/hashCalculator.d.ts +6 -0
  74. package/lib/hashCalculator.d.ts.map +1 -0
  75. package/lib/hashCalculator.js +14 -0
  76. package/lib/hashCalculator.js.map +1 -0
  77. package/lib/index.d.ts +16 -0
  78. package/lib/index.d.ts.map +1 -0
  79. package/lib/index.js +16 -0
  80. package/lib/index.js.map +1 -0
  81. package/lib/joinPaths.d.ts +19 -0
  82. package/lib/joinPaths.d.ts.map +1 -0
  83. package/lib/joinPaths.js +28 -0
  84. package/lib/joinPaths.js.map +1 -0
  85. package/lib/packageVersion.d.ts +9 -0
  86. package/lib/packageVersion.d.ts.map +1 -0
  87. package/lib/packageVersion.js +9 -0
  88. package/lib/packageVersion.js.map +1 -0
  89. package/package.json +22 -2
  90. package/platform-dependent/package.json +1 -1
  91. package/src/constants.ts +5 -0
  92. package/src/packageVersion.ts +1 -1
  93. package/dist/test/chronometer.spec.js +0 -90
  94. package/dist/test/chronometer.spec.js.map +0 -1
  95. package/dist/test/datastructures/collection.spec.js +0 -401
  96. package/dist/test/datastructures/collection.spec.js.map +0 -1
  97. package/dist/test/datastructures/dataArray.spec.js +0 -79
  98. package/dist/test/datastructures/dataArray.spec.js.map +0 -1
  99. package/dist/test/datastructures/sortedCollection.spec.js +0 -106
  100. package/dist/test/datastructures/sortedCollection.spec.js.map +0 -1
  101. package/dist/test/deterministicRandomGenerator.spec.js +0 -18
  102. package/dist/test/deterministicRandomGenerator.spec.js.map +0 -1
  103. package/dist/test/error_objects/flaggedError.spec.js +0 -23
  104. package/dist/test/error_objects/flaggedError.spec.js.map +0 -1
  105. package/dist/test/error_objects/httpError.spec.js +0 -61
  106. package/dist/test/error_objects/httpError.spec.js.map +0 -1
  107. package/dist/test/error_objects/httpErrorNoStack.spec.js +0 -55
  108. package/dist/test/error_objects/httpErrorNoStack.spec.js.map +0 -1
  109. package/dist/test/error_objects/operationError.spec.js +0 -132
  110. package/dist/test/error_objects/operationError.spec.js.map +0 -1
  111. package/dist/test/guidUtils.spec.js +0 -184
  112. package/dist/test/guidUtils.spec.js.map +0 -1
  113. package/dist/test/strings/joinPaths.spec.js +0 -18
  114. package/dist/test/strings/joinPaths.spec.js.map +0 -1
  115. package/dist/test/tsconfig.tsbuildinfo +0 -2278
  116. package/nyc/mocha-junit-report.xml +0 -175
  117. package/src/test/chronometer.spec.ts +0 -99
  118. package/src/test/datastructures/collection.spec.ts +0 -567
  119. package/src/test/datastructures/dataArray.spec.ts +0 -81
  120. package/src/test/datastructures/sortedCollection.spec.ts +0 -128
  121. package/src/test/deterministicRandomGenerator.spec.ts +0 -18
  122. package/src/test/error_objects/flaggedError.spec.ts +0 -22
  123. package/src/test/error_objects/httpError.spec.ts +0 -68
  124. package/src/test/error_objects/httpErrorNoStack.spec.ts +0 -64
  125. package/src/test/error_objects/operationError.spec.ts +0 -152
  126. package/src/test/guidUtils.spec.ts +0 -213
  127. package/src/test/strings/joinPaths.spec.ts +0 -17
  128. package/src/test/tsconfig.json +0 -21
  129. package/tsconfig.esnext.tsbuildinfo +0 -824
  130. package/tsconfig.tsbuildinfo +0 -823
@@ -0,0 +1,1219 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+ export declare const constants: {
6
+ MSG: {
7
+ /**
8
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
9
+ */
10
+ URL_MUST_BE_STRING: string;
11
+ /**
12
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
13
+ */
14
+ PORT_MUST_BE_NUMBER: string;
15
+ /**
16
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
17
+ */
18
+ TYPEID_NOT_DEFINED: string;
19
+ INVALID_PATH_IN_REFERENCE: string;
20
+ /**
21
+ * methods: Utils.traverseChangesetRecursively
22
+ * Your changeset contains an operator other than MODIFY, INSERT or REMOVE. If you created the changeset youserlf,
23
+ * check that you only use valid operators. Otherwise, this is an internal error. Please contact the development team.
24
+ */
25
+ UNKNOWN_OPERATOR: string;
26
+ /**
27
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
28
+ */
29
+ NON_PRIMITIVE_ARRAY_NO_TYPEID: string;
30
+ /**
31
+ * Filtering paths within arrays are not supported.
32
+ */
33
+ FILTER_PATH_WITHIN_ARRAY: string;
34
+ /**
35
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
36
+ * See specific message for more details.
37
+ */
38
+ ASSERTION_FAILED: string;
39
+ /**
40
+ * You used a deprecated function. It will likely be removed in the next major version.
41
+ * See the custom information if provided.
42
+ */
43
+ DEPRECATED_FUNCTION: string;
44
+ /**
45
+ * You used a deprecated function parameter. It will likely be removed in the next major version.
46
+ * See the custom information if provided.
47
+ */
48
+ DEPRECATED_PARAMETER: string;
49
+ /**
50
+ * You used an experimental feature. It will likely changed in future releases.
51
+ * See the custom information if provided.
52
+ */
53
+ EXPERIMENTAL_FEATURE: string;
54
+ /**
55
+ * This error message will be displayed when a repository creation fails
56
+ */
57
+ FAILED_REPOSITORY_CREATION: string;
58
+ /**
59
+ * This error message will be displayed when the deletion of a repository fails
60
+ */
61
+ FAILED_REPOSITORY_DELETION: string;
62
+ /**
63
+ * This error message will be displayed when the undelete operation of a repository fails
64
+ */
65
+ FAILED_REPOSITORY_UNDELETION: string;
66
+ /**
67
+ * This error message will be displayed when getting the expiry of a repository fails
68
+ */
69
+ FAILED_GET_EXPIRY_REQUEST: string;
70
+ /**
71
+ * This error message will be displayed when setting the expiry of a repository fails
72
+ */
73
+ FAILED_SET_EXPIRY_REQUEST: string;
74
+ /**
75
+ * This error message will be displayed when squashing commit history fails
76
+ */
77
+ FAILED_SQUASH_COMMIT_HISTORY: string;
78
+ /**
79
+ * This error message will be displayed when fetching a commit fails
80
+ */
81
+ FAILED_FETCH_COMMIT: string;
82
+ /**
83
+ * This error message will be displayed when containers creation fails
84
+ */
85
+ FAILED_CONTAINER_CREATION: string;
86
+ /**
87
+ * This error message will be displayed when a branch creation fails
88
+ */
89
+ FAILED_BRANCH_CREATION: string;
90
+ /**
91
+ * This error message will be displayed when a commit fails
92
+ */
93
+ FAILED_TO_COMMIT: string;
94
+ /**
95
+ * This error message will be displayed when a share operation fails
96
+ */
97
+ FAILED_SHARE: string;
98
+ /**
99
+ * This error message will be displayed when getting the branches of a repository fails
100
+ */
101
+ FAILED_GET_ENUMERATE_BRANCHES: string;
102
+ /**
103
+ * This error message will be displayed when a request to get an lca fails
104
+ */
105
+ FAILED_GET_LCA: string;
106
+ /**
107
+ * This error message will be displayed when a commit fails because of an internal error while committing
108
+ */
109
+ FAILED_TO_COMMIT_INTERNAL: string;
110
+ /**
111
+ * This error message will be displayed when getting a feature flag fails
112
+ */
113
+ FAILED_TO_GET_FEATURE: string;
114
+ /**
115
+ * This error message will be displayed when getting squashed commit range fails
116
+ */
117
+ FAILED_TO_GET_SQUASHED_COMMIT_RANGE: string;
118
+ /**
119
+ * methods: PropertyFactory.register
120
+ * The context ‘set’ is only valid for properties that are instances of NamedProperties. If you want to
121
+ * use a context of ‘set’, make sure your template includes:
122
+ * Inherits: ‘NamedProperty’
123
+ * Or
124
+ * Inherits: [‘NamedProperty’, …]
125
+ */
126
+ SET_ONLY_NAMED_PROPS: string;
127
+ /**
128
+ * You updated an existing template but the change to the version number was not as expected.
129
+ * Make sure you updated your version number correctly. You may have violated one of the following rules:
130
+ * - Adding one or more template attributes is a MINOR change.
131
+ * - Removing one or more template attributes is a MAJOR change.
132
+ */
133
+ CHANGE_LEVEL_TOO_LOW_1: string;
134
+ /**
135
+ * methods: PropertyFactory.register
136
+ * The template version number is not valid. A valid version number should look like: ‘1.0.0’
137
+ */
138
+ INVALID_VERSION_1: string;
139
+ /**
140
+ * methods: PropertyFactory.register
141
+ * Your property template should include a typeid attribute.
142
+ * @example
143
+ *```json
144
+ * {
145
+ * "typeid": "my.example:point2d-1.0.0",
146
+ * "properties": [
147
+ * {"id": "x", "typeid": "Float64"},
148
+ * {"id": "y", "typeid": "Float64"}
149
+ * ]
150
+ *}
151
+ *```
152
+ */
153
+ MISSING_TYPE_ID: string;
154
+ /**
155
+ * methods: PropertyFactory.register
156
+ * Typeid should contain a template version number.
157
+ * @example
158
+ * “typeid: my.example:point2d-1.0.0”
159
+ */
160
+ MISSING_VERSION: string;
161
+ /**
162
+ * methods: PropertyFactory.register
163
+ * The template you are using is different from the previous version and you did not update the version number.
164
+ * If any changes were made to the template, you should update the version number to a higher number.
165
+ * - Major change: removing one or more attribute (e.g. 1.0.0 -\> 2.0.0)
166
+ * - Minor change: adding one or more attribute (e.g. 1.0.0 -\> 1.1.0)
167
+ * - Patch: template description changes (e.g. 1.0.0 -\> 1.0.1)
168
+ */
169
+ MODIFIED_TEMPLATE_1: string;
170
+ /**
171
+ * methods: PropertyFactory.register
172
+ * When changing your template, you need to increase its version number. For example, if the previous version
173
+ * number was 1.0.0, it should increase to 1.0.1 for a patch (if the template description has changed),
174
+ * to 1.1.0 for a minor change (if you added one or more attributes) or to 2.0.0 for a major change (if you
175
+ * removed one or more attributes).
176
+ */
177
+ MODIFIED_TEMPLATE_SAME_VERSION_1: string;
178
+ /**
179
+ * methods: PropertyFactory.register
180
+ * PropertyFactory.register requires a template as a parameter.
181
+ */
182
+ NO_TEMPLATE: string;
183
+ /**
184
+ * methods: PropertyFactory.register
185
+ * When updating a template’s version number, the version number can only increase, never decrease.
186
+ */
187
+ VERSION_REGRESSION_1: string;
188
+ /**
189
+ * Your template contains a typeid that is not a string.
190
+ */
191
+ TYPEID_MUST_BE_STRING: string;
192
+ /**
193
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
194
+ * The TemplateValidator constructor should have in its parameters param.inheritsFrom and params.hasSchema.
195
+ * Neither of them can be undefined.
196
+ */
197
+ MISSING_INHERITSFROM_OR_HASSCHEMA: string;
198
+ /**
199
+ * Your template has an invalid key for the kind of map it is.
200
+ */
201
+ KEY_MUST_BE_TYPEID: string;
202
+ /**
203
+ * Your template has an invalid contextKeyType parameter.
204
+ */
205
+ INVALID_OPTION_NONE_CONSTANTS: string;
206
+ /**
207
+ * You tried to use draft as a versoin when it is not enabled.
208
+ */
209
+ DRAFT_AS_VERSION_TYPEID: string;
210
+ /**
211
+ * methods: NodeProperty.remove
212
+ * The property you tried to remove does not exist (its id was not found) - check that the id is correct
213
+ * and that the property has not already been removed.
214
+ */
215
+ REMOVING_NON_EXISTING_ID: string;
216
+ /**
217
+ * methods: BranchNode.isEqual, CommitNode.isEqual
218
+ * In_node parameter is required. In_node is the branch or commit you wish to compare to ‘this’ branch/commit
219
+ * node to check for equality.
220
+ */
221
+ MISSING_IN_NODE_PARAM: string;
222
+ /**
223
+ * methods: BranchNode, CommitNode, Workspace.commit
224
+ * The BranchNode or CommitNode constructor was called without in_params.guid or we tried to send a commit
225
+ * without a guid.
226
+ */
227
+ MISSING_GUID_FIELD: string;
228
+ /**
229
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
230
+ */
231
+ LOCAL_AND_REMOTE_BRANCH_NOT_EQUAL: string;
232
+ /**
233
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
234
+ */
235
+ BRANCH_NOT_REMOTE_BRANCH: string;
236
+ /**
237
+ * now rebasing to \<commit guid\>'
238
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
239
+ * A commit node already rebased has been rebased again.
240
+ */
241
+ COMMIT_ALREADY_REBASED: string;
242
+ /**
243
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
244
+ * A new commit has been received from the server but was not expected. See specific message for more details.
245
+ */
246
+ UNEXPECTED_COMMIT_FROM_SERVER: string;
247
+ /**
248
+ * This error will occur if the repository associated to a branch hasn't been found.
249
+ */
250
+ REPOSITORY_NOT_FOUND: string;
251
+ /**
252
+ * This error will occur if the branch within a repository hasn't been found.
253
+ */
254
+ BRANCH_NOT_FOUND: string;
255
+ /**
256
+ * methods: PropertyFactory.create
257
+ * Each property created with PropertyFactory.create should have a unique id. You should make sure your
258
+ * code generates a unique id for each property created, or make your property an instanced of NamedProperties
259
+ * (which are identified by a unique Urn)
260
+ */
261
+ OVERWRITING_ID: string;
262
+ /**
263
+ * methods: PropertyFactory.register
264
+ * Warning: The template passed into the register method does not match the expected structure for this type.
265
+ */
266
+ TEMPLATE_MISMATCH: string;
267
+ /**
268
+ * methods: PropertyFactory.register
269
+ * The typeid assigned to your property template should include a version.
270
+ * E.g. 1.0.0 - an example of a valid typeid: “my.example:point2d-1.0.0”
271
+ */
272
+ UNVERSIONED_TEMPLATE: string;
273
+ /**
274
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
275
+ * Error occurs when a template has been inserted into the branch without a SEMVER version.
276
+ * This can occur when registering templates through the commit REST interface. At this point
277
+ * the data is corrupted and should be reported to the development team
278
+ */
279
+ UNVERSIONED_REMOTE_TEMPLATE: string;
280
+ /**
281
+ * methods: PropertyFactory.create
282
+ * RepositoryReferences are not yet fully implemented. They will be soon.
283
+ */
284
+ REPOSITORY_REF_NOT_FULLY_IMPLEMENTED: string;
285
+ /**
286
+ * methods: PropertyFactory.create
287
+ * When using ‘inherits’ in your property template, it must be a string or an array.
288
+ * @example
289
+ * ```json
290
+ * {
291
+ * typeid:'my.example:point2d-1.0.0',
292
+ * inherits: ‘ another property’
293
+ * }
294
+ * ```
295
+ * or :
296
+ * ```json
297
+ * {
298
+ * typeid:'my.example:point2d-1.0.0',
299
+ * inherits: [‘another property’, ‘property2’]
300
+ * }
301
+ * ```
302
+ */
303
+ INHERITS_ARRAY_OR_STRING: string;
304
+ /**
305
+ * methods: PropertyFactory.create
306
+ * Context can be ‘array, ‘set’, ‘map’, ‘enum’ or ‘single’. If not specified, will default to ‘single’.
307
+ */
308
+ UNKNOWN_CONTEXT_SPECIFIED: string;
309
+ /**
310
+ * methods: PropertyFactory.create
311
+ * The property you entered into PropertyFactory.create has a typeid that is not registered.
312
+ * Make sure you register the template before creating an instance of that property. This could
313
+ * also be caused by a failure in the registration process.
314
+ */
315
+ UNKNOWN_TYPEID_SPECIFIED: string;
316
+ /**
317
+ * methods: PropertyFactory.getAllParentsForTemplate, PropertyFactory.inheritsFrom
318
+ * Cannot find a template for this typeid. Make sure you registered the template and that the typeid
319
+ * is entered correctly. This can be an error with the template you are trying to insert or one of the
320
+ * templates it inherits from.
321
+ */
322
+ NON_EXISTING_TYPEID: string;
323
+ /**
324
+ * methods: PropertyFactory.register
325
+ * The property you passed in to .register is a primitive property. These do not need to be registered with a
326
+ * typeid. It can be created without being registered. E.g. PropertyFactory.create(‘String’)
327
+ */
328
+ CANNOT_REGISTER_PRIMITIVE: string;
329
+ /**
330
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
331
+ * Your template’s id field must be a string.
332
+ */
333
+ DEFINITION_ID_MUST_BE_STRING: string;
334
+ /**
335
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
336
+ * The "$ref" keyword is used to reference a schema, and provides the ability to validate recursive structures
337
+ * through self-reference.
338
+ * An object schema with a "$ref" property MUST be interpreted as a "$ref" reference. The value of the "$ref"
339
+ * property MUST be a URI Reference (a string)
340
+ */
341
+ REF_SHOULD_BE_STRING: string;
342
+ /**
343
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
344
+ * The identifier passed to $ref does not point to any schema.
345
+ */
346
+ COULD_NOT_FIND_REFERENCE: string;
347
+ /**
348
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
349
+ * The identifier passed to $ref does not point to an object.
350
+ */
351
+ REFERENCED_DEFINITION_SHOULD_BE_OBJECT: string;
352
+ /**
353
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
354
+ * In a JSON schema, the properties field must be an object.
355
+ */
356
+ PROPERTIES_SHOULD_BE_OBJECT: string;
357
+ /**
358
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
359
+ * oneOf’s value MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema.
360
+ * An instance validates successfully against this keyword if it validates successfully against exactly one
361
+ * schema defined by this keyword's value.
362
+ */
363
+ ONE_OF_ONLY_FOR_ARRAYS_OF_ONE_OBJECT: string;
364
+ /**
365
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
366
+ * oneOf’s value MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema.
367
+ */
368
+ ONE_OF_SHOULD_CONTAIN_OBJECTS: string;
369
+ /**
370
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
371
+ * This keyword's value MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema.
372
+ */
373
+ ALL_OF_SHOULD_BE_ARRAY: string;
374
+ /**
375
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
376
+ * This keyword's value MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema.
377
+ */
378
+ ALL_OF_SHOULD_CONTAIN_OBJECTS: string;
379
+ /**
380
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
381
+ * Your schema definition contains infinite recursion. For example, if your definition ‘a’ refers to definition
382
+ * ‘b’ as being one of its children and ‘b’ refers to ‘a’ as one of its children.
383
+ */
384
+ INFINITE_RECURSION: string;
385
+ /**
386
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
387
+ * One part of your template object might contain something that is not of type ‘object’, ‘string’,
388
+ * ‘number’ or ‘integer’.
389
+ */
390
+ UNSUPPORTED_VALUE_TYPE: string;
391
+ REQUIRED_PROPERTY_NAME_NOT_STRING: string;
392
+ /**
393
+ * This property is required but it is not listed in the properties field.
394
+ */
395
+ PROPERTY_NAME_DOES_NOT_MATCH: string;
396
+ /**
397
+ * The ‘inherits’ field in your template object should be a string or an array of strings.
398
+ */
399
+ INHERITS_SHOULD_BE_STRING: string;
400
+ /**
401
+ * The ‘context’ field in your template should be a string.
402
+ */
403
+ CONTEXT_SHOULD_BE_STRING: string;
404
+ /**
405
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
406
+ * Warning: If you have a ‘length’ field in your template and the context is not set to ‘array’,
407
+ * ‘length’ will be ignored.
408
+ */
409
+ IGNORING_LENGTH_NOT_ARRAY: string;
410
+ /**
411
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
412
+ * In your template, the field ‘length’ should be a number.
413
+ */
414
+ LENGTH_SHOULD_BE_NUMBER: string;
415
+ /**
416
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
417
+ * Your template contains more than one definition field for this field.
418
+ */
419
+ DUPLICATE_DEFINITION: string;
420
+ /**
421
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
422
+ * The field ‘id’ is missing from your JSON schema.
423
+ */
424
+ FIELD_ID_IS_REQUIRED: string;
425
+ /**
426
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
427
+ * You need a ‘typeid’ field in your template schema.
428
+ * @example
429
+ * ```json
430
+ * {
431
+ * ‘typeid’: 'autodesk.test:set.set-1.0.0',
432
+ * ‘properties’: [
433
+ * {‘typeid’: 'String',
434
+ * ‘context’: 'set',
435
+ * ‘id’: 'DummySet',
436
+ * ‘inherits’:['NamedProperty']}
437
+ * ]
438
+ * }
439
+ *```
440
+ */
441
+ FIELD_TYPEID_IS_REQUIRED: string;
442
+ /**
443
+ * methods: PropertyFactory.register
444
+ * The ‘length’ field in your template must be a number.
445
+ */
446
+ LENGTH_MUST_BE_NUMBER: string;
447
+ /**
448
+ * methods: PropertyFactory.register
449
+ * Each entry in your enum property array must have an id.
450
+ * @example
451
+ * ```json
452
+ * {
453
+ * "typeid": "Adsk.Core:Units.Metric-1.0.0",
454
+ * "inherits": "Enum",
455
+ * "annotation": { "description": "The metric units" },
456
+ * "properties": [
457
+ * { "id": "m" , "value": 1, "annotation": { "description": "meter" }},
458
+ * { "id": "cm", "value": 2, "annotation": { "description": "centimeter" }},
459
+ * { "id": "mm", "value": 3, "annotation": { "description": "millimeter" }}
460
+ * ]
461
+ * }
462
+ * ```
463
+ */
464
+ ENUM_TYPEID_MISSING: string;
465
+ /**
466
+ * methods: PropertyTemplate constructor
467
+ * Each entry in your enum property must have a value that is a number.
468
+ * @example
469
+ * ```json
470
+ * {
471
+ * "typeid": "Adsk.Core:Units.Metric-1.0.0",
472
+ * "inherits": "Enum",
473
+ * "annotation": { "description": "The metric units" },
474
+ * "properties": [
475
+ * { "id": "m" , "value": 1, "annotation": { "description": "meter" }},
476
+ * { "id": "cm", "value": 2, "annotation": { "description": "centimeter" }},
477
+ * { "id": "mm", "value": 3, "annotation": { "description": "millimeter" }}
478
+ * ]
479
+ * }
480
+ * ```
481
+ */
482
+ ENUM_VALUE_NOT_NUMBER: string;
483
+ /**
484
+ * methods: PropertyTemplate.getVersion
485
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
486
+ * Warning: you that the template on which you are calling the .getVersion method is not versioned.
487
+ * The method will return undefined. This should not happen as we now validate that all templates are
488
+ * versioned when registering them.
489
+ */
490
+ TEMPLATE_NOT_VERSIONED: string;
491
+ /**
492
+ * methods: PropertyFactory.register
493
+ * Warning: Template already exists. The incoming template MUST match what is currently registered.
494
+ * If they do not match, an error will be thrown letting you know that the templates are incompatible.
495
+ * See error PF-004
496
+ */
497
+ REGISTERING_EXISTING_TYPEID: string;
498
+ /**
499
+ * methods: PropertyFactory.register
500
+ * There were errors validating the template you are trying to register. See detailed errors attached.
501
+ */
502
+ FAILED_TO_REGISTER: string;
503
+ /**
504
+ * methods: PropertyFactory.convertToTemplates, PropertyFactory.registerFrom
505
+ * So far, these methods can only convert from a JSON schema. The first parameter (in_fromType)
506
+ * must be ‘JSONSchema’.
507
+ */
508
+ UNKNOWN_TYPE: string;
509
+ /**
510
+ * methods: PropertyTemplate.serializeCanonical
511
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
512
+ * This error shouldn’t occur. The underlying private function that is called is a close cousin of the
513
+ * deepCopy function which could have an arbitrary target specified. This doesn’t happen in the case of
514
+ * the serializeCanonical.
515
+ */
516
+ INVALID_TARGET_PROPERTY_TEMPLATE: string;
517
+ /**
518
+ * methods: PropertyFactory.loadTemplate
519
+ * In order for the PropertyFactory to retrieve templates from remote store it has to have at least one store
520
+ * interface to interact with. This is accomplished by making the PropertyFactory.addStore call.
521
+ */
522
+ MISSING_CASE_IN_TEMPLATE_SERIALIZATION: string;
523
+ OVERRIDDING_INHERITED_TYPES: string;
524
+ /**
525
+ * methods: PropertyFactory.register
526
+ * PropertyFactory.register takes one parameter, which can be a string (typeid), a json object (a template) or an
527
+ * array of these.
528
+ */
529
+ ATTEMPT_TO_REGISTER_WITH_BAD_ARGUMENT: string;
530
+ /**
531
+ * methods: PropertyFactory.resolve
532
+ * No store has been added yet to the PropertyFactory. A template store has to be instantiated then added with
533
+ * propertyFactory.addStore()
534
+ */
535
+ NO_STORE_HAS_BEEN_INITIALIZED_YET: string;
536
+ /**
537
+ * methods: PropertyFactory.resolve
538
+ * resolve cannot be called until previous call to resolve has completed.
539
+ */
540
+ DEPENDENCIES_RESOLUTION_IN_PROGRESS: string;
541
+ /**
542
+ * methods: PropertyFactory.create
543
+ * Typed values must contain properties that inherit from the base type.
544
+ */
545
+ TYPED_VALUES_MUST_DERIVE_FROM_BASE_TYPE: string;
546
+ /**
547
+ * methods: PropertyFactory.create
548
+ * The field ‘value’ is missing from your JSON schema.
549
+ */
550
+ FIELD_VALUE_IS_REQUIRED: string;
551
+ /**
552
+ * methods: PropertyFactory.register
553
+ * Warning: The structure of the template passed into the register method does not match the structure of a remote template registered under the same typeid.
554
+ */
555
+ REMOTE_TEMPLATE_MISMATCH: string;
556
+ /**
557
+ * methods: PropertyFactory.initializeSchemaStore
558
+ * Warning: The initializeSchemaStore method must be provided with an options object
559
+ containing a getBearerToken function and the url to the ForgeSchemaService.
560
+ */
561
+ MISSING_FSS_INIT_OPTIONS: string;
562
+ /**
563
+ * methods: PropertyFactory.initializeSchemaStore
564
+ * Warning: The initializeSchemaStore method url option must be passed a valid base url.
565
+ */
566
+ FSS_BASEURL_WRONG: string;
567
+ /**
568
+ * methods: PropertyFactory.create
569
+ * Overridden properties must have same context as the base type.
570
+ */
571
+ OVERRIDEN_PROP_MUST_HAVE_SAME_CONTEXT_AS_BASE_TYPE: string;
572
+ /**
573
+ * methods: PropertyFactory.create
574
+ * Primitive types does not support typedValues.
575
+ */
576
+ TYPED_VALUES_FOR_PRIMITIVES_NOT_SUPPORTED: string;
577
+ /**
578
+ * methods: PropertyFactory.inheritsFrom
579
+ */
580
+ TYPEID_IS_NOT_ENUM: string;
581
+ TYPEID_NOT_NATIVE: string;
582
+ /**
583
+ * methods: ArrayProperty.length.set, StringProperty.length.set
584
+ * Cannot directly set the array.length or string.length. This is a read-only property.
585
+ */
586
+ MODIFY_READ_ONLY: string;
587
+ /**
588
+ * methods: Property.getRelativePath
589
+ * There is no path between the property and the ancestor you passed in to .getRelativePath.
590
+ */
591
+ NO_PATH_BETWEEN: string;
592
+ /**
593
+ * methods: Property.applyChangeSet
594
+ * One of the paths included in your changeSet is not valid for this property.
595
+ * Check that the modifications in the changeSet match the structure of the template.
596
+ */
597
+ INVALID_PATH: string;
598
+ /**
599
+ * methods: NodeProperty.insert
600
+ * The property you inserted into a NodeProperty has a parent.
601
+ * If your property has a parent, changing the property’s id will break the parent.
602
+ * Make the change to the parent first.
603
+ */
604
+ ID_CHANGE_FOR_PROPERTY_WITH_PARENT: string;
605
+ /**
606
+ * methods: Property.resolvePath
607
+ * Part of the path entered to Property.resolvePath was not valid.
608
+ */
609
+ INVALID_PATH_TOKEN: string;
610
+ /**
611
+ * methods: MapProperty.insert, NodeProperty.insert, ReferenceMapProperty.insert, Workspace.insert,
612
+ * SetProperty.insert
613
+ * Your map, set or nodeproperty already contains an entry under in_key.
614
+ */
615
+ PROPERTY_ALREADY_EXISTS: string;
616
+ /**
617
+ * methods: MapProperty.applyChangeset, NodeProperty.applyChangeset, SetProperty.applyChangeset
618
+ * The changeset you applied contains properties that have already been inserted.
619
+ * Check the ‘insert’ fields in your changeSet for properties that might already exist.
620
+ */
621
+ INSERTED_EXISTING_ENTRY: string;
622
+ /**
623
+ * methods: MapProperty.remove, SetProperty.remove
624
+ * Tried to remove an entry that does not exist.
625
+ * This can be caused indirectly by deserialize / applyChangeset methods.
626
+ * One of the ‘remove’ fields in your changeSet must contain a property that does not exist.
627
+ */
628
+ REMOVED_NON_EXISTING_ENTRY: string;
629
+ /**
630
+ * methods: MapProperty.applyChangeset, NodeProperty.applyChangeset, SetProperty.applyChangeset
631
+ * One of the key you are trying to modify in your changeSet does not exist.
632
+ * One of the ‘modify’ fields in your changeSet refers to a property that does not exist.
633
+ */
634
+ MODIFY_NON_EXISTING_ENTRY: string;
635
+ /**
636
+ * methods: MapProperty.insert, MapProperty.set, SetProperty.insert, NodeProperty.insert
637
+ * The value you are trying to insert in your map property, set property or node property has a parent.
638
+ * You cannot insert a property that has a parent.
639
+ */
640
+ INSERTED_ENTRY_WITH_PARENT: string;
641
+ /**
642
+ * methods: Property.resolvePath, Workspace.resolvePath
643
+ * Paths should not contain empty sections such as ‘..’, ‘//’ or ‘[], etc.
644
+ * Sections in the path are delimited by ‘.’ ‘[ ]’, ‘/’ .
645
+ * There should always be a path between any two delimiters.
646
+ */
647
+ EMPTY_TOKEN: string;
648
+ /**
649
+ * methods: Property.resolvePath, Workspace.resolvePath
650
+ * Paths should not contain quotes except at the beginning and end of the path.
651
+ * For example: resolvePath('my"path.nested".other') is not valid because the first quote is in front of ‘path’
652
+ * but after the ‘.nested’ which is part of the subsequent path.
653
+ */
654
+ QUOTES_WITHIN_TOKEN: string;
655
+ /**
656
+ * methods: Property.resolvePath, Workspace.resolvePath
657
+ * Paths should not end with a ‘.’
658
+ */
659
+ DOT_AT_END: string;
660
+ /**
661
+ * methods: Property.resolvePath, Workspace.resolvePath
662
+ * Paths using square brackets should not contain ‘.’ within those square brackets.
663
+ * If your path contains any dots, these should be escaped e.g. [my\.path] instead of [my.path].
664
+ */
665
+ DOTS_IN_SQUARE_BRACKETS: string;
666
+ /**
667
+ * methods: Property.resolvePath, Workspace.resolvePath
668
+ * resolvePath error while parsing your string.
669
+ * It encountered an end to a path segment that was not
670
+ * followed by a “.” or a “[“ indicating the beginning of a new segment.
671
+ */
672
+ MISSING_DOT_AT_SEGMENT_START: string;
673
+ /**
674
+ * methods: Property.resolvePath, Workspace.resolvePath
675
+ * Closing square bracket not followed by the correct character (., [ or *).
676
+ * For example, this is not valid: resolvePath(myArray[2]nested).
677
+ * This is valid: resolvePath(myArray[2].nested).
678
+ */
679
+ INVALID_END_OF_SQUARE_BRACKETS: string;
680
+ /**
681
+ * methods: Property.resolvePath, Workspace.resolvePath
682
+ * Every opening bracket ([) needs a matching closing bracket (])
683
+ */
684
+ UNCLOSED_BRACKETS: string;
685
+ /**
686
+ * methods: Property.resolvePath, Workspace.resolvePath
687
+ * Any closing bracket (]) must be preceded by a matching opening bracket ([).
688
+ */
689
+ CLOSING_BRACKET_WITHOUT_OPENING: string;
690
+ /**
691
+ * methods: Property.resolvePath, Workspace.resolvePath
692
+ */
693
+ INVALID_ESCAPE_SEQUENCE: string;
694
+ /**
695
+ * methods: Property.resolvePath, Workspace.resolvePath
696
+ * A quotation mark at the beginning of a path must have a matching closing quotation mark
697
+ * at the end of the same path.
698
+ */
699
+ UNCLOSED_QUOTATION_MARKS: string;
700
+ /**
701
+ * methods: SetProperty.insert, SetProperty.set, SetProperty.setValues
702
+ * The property you insert in a setProperty must be an instance of NamedProperty.
703
+ * When creating the property to be inserted, make sure it inherits from NamedProperty.
704
+ * @example
705
+ * #Creating a property that inherits from NamedProperty
706
+ * ```json
707
+ * {
708
+ * typeid:”my.example:myprop-1.0.0”,
709
+ * inherits:’NamedProperty’ (or [‘NamedProperty’, …]
710
+ * ...
711
+ * }
712
+ *```
713
+ */
714
+ CANT_INSERT_NON_NAMED_PROPERTIES: string;
715
+ /**
716
+ * methods: NodeProperty.insert, Workspace.insert
717
+ * The property you inserted does not have an id.
718
+ * Unless the property is an instance of NamedProperty, you must pass in an id as the first parameter
719
+ * (and the property second)
720
+ */
721
+ ADDED_CHILD_WITHOUT_ID: string;
722
+ /**
723
+ * methods: ArrayProperty.resolvePath
724
+ * Cannot use .resolvePath on a primitive array, only on a Custom type array.
725
+ * For a primitive array, use .getValue instead.
726
+ * For example, instead of MyValueArray.resolvePath(1), use MyValueArray.getValue(1)
727
+ */
728
+ NO_PATHS_FOR_NON_PRIMITIVE_ARRAYS: string;
729
+ /**
730
+ * methods: ArrayProperty.resolvePath
731
+ * When using an array index as part of your path, it needs to have a numeric value.
732
+ */
733
+ INVALID_NON_NUMERIC_SEGMENT_IN_PATH: string;
734
+ /**
735
+ * methods: ArrayProperty.getRelativePath, ArrayProperty.getAbsolutePath
736
+ * INTERNAL ERROR
737
+ * If you encounter this error, please contact the development team.
738
+ * Part of the path you are trying to find points to a non-existing array item.
739
+ */
740
+ GET_PATH_SEGMENT_CALLED_FOR_NON_ENTRY: string;
741
+ /**
742
+ * methods:
743
+ * The changeSet passed to .deserialize was not a valid non-normalized changeset.
744
+ */
745
+ NO_NORMALIZED_CHANGESET: string;
746
+ /**
747
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
748
+ * One of your changesets contained a NamedProperty without a GUID.
749
+ * This should not happen and should have been validated already.
750
+ */
751
+ MISSING_GUID_IN_NORMALIZED_CHANGESET: string;
752
+ /**
753
+ * methods: EnumProperty.getEnumString, EnumProperty.setValue, EnumProperty.setEnumByString,
754
+ * EnumProperty.getEnumString, EnumArrayProperty.getEnumStrings
755
+ * This Enum Property does not have any entry with that value.
756
+ * EnumProperty.getEnumByString -\> the EnumProperty you used to pass this function does not have an entry.
757
+ * EnumProperty.setValue -\> no entry exists for in_value
758
+ * EnumProperty.setEnumByString -\> no entry exists for in_stringId
759
+ * EnumArrayProperty.getEnumString -\> the value found at in_position does not correspond to an entry.
760
+ * EnumArrayProperty.getEnumStrings -\> one of the values found at one of the positions sought does
761
+ * not correspond to an entry.
762
+ */
763
+ UNKNOWN_ENUM: string;
764
+ /**
765
+ * methods: Property.applyChangeSet
766
+ * Changeset contains an operation that is unknown.
767
+ * Valid operations are insert, modify and remove.
768
+ */
769
+ UNKNOWN_OPERATION: string;
770
+ /**
771
+ * methods: Workspace.remove, NodeProperty.remove
772
+ * The property you passed to workspace.remove or nodeProperty.remove does not exist.
773
+ * Check that you passed the correct property, and that it has not yet been removed.
774
+ */
775
+ REMOVING_NON_EXISTING_KEY: string;
776
+ /**
777
+ * methods: Workspace.get, Property.get
778
+ * Workspace.get and Property.get take in an id (string or number) or an array of ids.
779
+ * @example
780
+ * ```ts
781
+ *.get(‘position’).get(‘x’) or .get([‘property’, ‘x’])
782
+ * ```
783
+ */
784
+ STRING_OR_ARRAY_STRINGS: string;
785
+ /**
786
+ * methods: Property.serialize
787
+ * Property.serialize only takes in one parameter: an options object. That parameter is optional.
788
+ */
789
+ SERIALIZE_TAKES_OBJECT: string;
790
+ /**
791
+ * ArrayProperty.insert, ArrayProperty.insertRange
792
+ * The in_position (for .insert) or in_offset (for .insertRange) should not be smaller than 0
793
+ * or larger than the length of the array.
794
+ */
795
+ START_OFFSET_INVALID: string;
796
+ /**
797
+ * ArrayProperty.remove, ArrayProperty.removeRange, ArrayProperty.pop
798
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
799
+ * The item (or one of the items) you are trying to remove from the array has a parent that is not the array.
800
+ * This should not happen because you should not have been able to insert the item in the array in the first place.
801
+ */
802
+ CANNOT_REMOVE_WITH_DIFFERENT_PARENT: string;
803
+ /**
804
+ * methods ArrayProperty.set, ArrayProperty.setRange
805
+ * Your first parameter: in_position (for .set) and in_offset (for .setRange) cannot have a negative value.
806
+ */
807
+ START_OFFSET_NEGATIVE: string;
808
+ /**
809
+ * methods: ArrayProperty.removeRange, ArrayProperty.setRange, ArrayProperty.insertRange,
810
+ * ArrayProperty.insert, EnumArrayProperty.getEnumStrings
811
+ * The parameter needs to be a number.
812
+ * For .removeRange: in_offset and in_deleteCount
813
+ * For .setRange: in_offset
814
+ * For .insertRange: in_offset
815
+ * For .getEnumStrings: in_offset, in_length
816
+ * For StringProperty.insert: in_position
817
+ */
818
+ NOT_NUMBER: string;
819
+ /**
820
+ * methods: Property.traverseUp, Property.traverseDown
821
+ * Property.traverseUp and Property.traverseDown take one parameter: a callback function
822
+ */
823
+ CALLBACK_NOT_FCT: string;
824
+ /**
825
+ * methods: ArrayProperty.insertRange
826
+ * Array.insertRange takes two parameters. The second one (in_array) must be an array.
827
+ * To pass in only one item, either use .insert(index, item)
828
+ * or put that item into an array: .insertRange(index, [item])
829
+ */
830
+ IN_ARRAY_NOT_ARRAY: string;
831
+ /**
832
+ * methods: EnumProperty.setEnumByString
833
+ * EnumProperty.setEnumByString takes one parameter: a string id. It must be a string.
834
+ */
835
+ STRING_ID_MUST_BE_STRING: string;
836
+ /**
837
+ * methods: Integer64Property.setValueHigh
838
+ * Integer64Property.setValueHigh takes one parameter: a number.
839
+ */
840
+ IN_HIGH_MUST_BE_NUMBER: string;
841
+ /**
842
+ * methods: Integer64Property.setValueLow
843
+ * Integer64Property.setValueLow takes one parameter: a number.
844
+ */
845
+ IN_LOW_MUST_BE_NUMBER: string;
846
+ /**
847
+ * methods: IntegerProperty.toString
848
+ * Integer64Property.toString takes one optional parameter: a number (in_radix).
849
+ * If no value is passed, will default to 10.
850
+ */
851
+ IN_RADIX_MUST_BE_NUMBER: string;
852
+ /**
853
+ * methods: IntegerProperty.fromString
854
+ * Integer64Property.fromString takes two parameters. The first parameter (in_string) must be a string.
855
+ * (the second parameter is in_radix, a number. It is optional: defaults to 10).
856
+ */
857
+ IN_STRING_MUST_BE_STRING: string;
858
+ /**
859
+ * methods: Integer64Property.fromString
860
+ * Integer64Property.fromString takes two parameters. The second parameter is optional but if passed,
861
+ * it must be a number between 2 and 36. If not passed, it defaults to 10. (the first parameter is
862
+ * in_string and must be a string).
863
+ */
864
+ IN_RADIX_BETWEEN_2_36: string;
865
+ /**
866
+ * methods MapProperty.insert, ReferenceMapProperty.set
867
+ * MapProperty.insert and ReferenceMapProperty.set both take two parameters.
868
+ * The first parameter (in_key) must be a string.
869
+ */
870
+ KEY_NOT_STRING: string;
871
+ /**
872
+ * methods: NodeProperty.insert, Workspace.insert
873
+ * he second parameter (in_property) must be a valid property (it must be an instance of BaseProperty).
874
+ */
875
+ NOT_A_PROPERTY: string;
876
+ /**
877
+ * methods: ReferenceProperty.set / setValue, ReferenceMapProperty.insert / set / setValue / setValues,
878
+ * ReferenceArrayProperty.enqueue / push / unshift / insert / insertRange / set / setRange / setValue / setValues
879
+ * The provided value (or values) must be a valid property (an instance of BaseProperty), be undefined or a string (a path).
880
+ */
881
+ PROPERTY_OR_UNDEFINED: string;
882
+ /**
883
+ * ArrayProperty.insertRange, ArrayProperty.insert, ArrayProperty.push
884
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
885
+ * The item (or one of the items) you are trying to insert in this array has a parent that is not the array.
886
+ */
887
+ NO_INSERT_WITH_PARENT: string;
888
+ /**
889
+ * methods: ArrayProperty.get
890
+ * ArrayProperty.get takes in one parameter: in_position, which can a single position or an array.
891
+ * If it is a single position, it is the numerical position of the item in the array.
892
+ * It must be a number or a string that parses into a number (e.g. '2').
893
+ * If you pass in an array, the first item of the array must be a number or a string that parses into a number.
894
+ * (other items in the array are child paths within the array item at this position).
895
+ * This error happens only when in_position is an array.
896
+ */
897
+ FIRST_ITEM_MUST_BE_NUMBER: string;
898
+ /**
899
+ * methods: ArrayProperty.get
900
+ * ArrayProperty.get takes in one parameter: in_position, which can a single position or an array.
901
+ * If it is a single position, it is the numerical position of the item in the array.
902
+ * It must be a number or a string that parses into a number (e.g. '2').
903
+ * If you pass in an array, the first item of the array must be a number or a string that parses into a number
904
+ * (other items in the array are child paths within the array item at this position).
905
+ * This error happens only when in_position is a single position.
906
+ */
907
+ IN_POSITION_MUST_BE_NUMBER: string;
908
+ /**
909
+ * methods: Property.getValue
910
+ * Property.getValue takes one parameter: in_id.
911
+ * It can either be a string or an array of strings. It cannot be an empty array.
912
+ */
913
+ CANNOT_BE_EMPTY_ARRAY: string;
914
+ /**
915
+ * methods: EnumArrayProperty.set
916
+ * EnumArrayProperty.set takes two parameters: in_index and in_value.
917
+ * In_value should be a number. setValue cannot be used to set enum by string.
918
+ * Use .setEnumByString instead.
919
+ */
920
+ VALUE_SHOULD_BE_NUMBER: string;
921
+ /**
922
+ * methods: EnumArrayProperty.setEnumByString
923
+ * EnumArrayProperty.setEnumByString cannot be use to set enum by number. Use .set instead.
924
+ */
925
+ VALUE_SHOULD_BE_STRING: string;
926
+ /**
927
+ * methods: ArrayProperty.get
928
+ * In_position or in_offset is either lower than 0 or higher than the length of the array.
929
+ * Make sure that the property you are trying to get from the array exists and that the position is correct.
930
+ */
931
+ GET_OUT_OF_RANGE: string;
932
+ /**
933
+ * methods: ArrayProperty.setRange, ArrayProperty.set
934
+ * setRange: Either in_offset is lower than zero or in_offset + length of in_array is higher than
935
+ * the length of the array. If you need to add items that were not there before, add those using
936
+ * .push, .insert or .insertRange.
937
+ */
938
+ SET_OUT_OF_BOUNDS: string;
939
+ /**
940
+ * methods: ArrayProperty.removeRange, ArrayProperty.remove
941
+ * RemoveRange: Either in_offset is smaller than zero or in_offset + in_deleteCount is higher than
942
+ * the length of the array. Make sure that the properties you are trying to remove exist in that
943
+ * array and that you entered the positions correctly.
944
+ * Remove: in_offset is either smaller than zero or larger than the length of the array.
945
+ */
946
+ REMOVE_OUT_OF_BOUNDS: string;
947
+ /**
948
+ * methods: PropertyFactory.create
949
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
950
+ * Warning: Something went wrong when creating your property: it did not successfully create
951
+ * the property and then tried to set its value.
952
+ */
953
+ NON_EXISTING_PROPERTY_REPOSITORY_REFERENCE: string;
954
+ /**
955
+ * methods: Property.setValues
956
+ * One of the path you used in .setValues leads to a property.
957
+ * When passing an object to setValues, make sure that all paths lead to a primitive value.
958
+ */
959
+ SET_VALUES_PATH_PROPERTY: string;
960
+ /**
961
+ * methods: Property.setValues
962
+ * One of the path in the object you passed to .setValues does not match the structure of this property.
963
+ */
964
+ SET_VALUES_PATH_INVALID: string;
965
+ /**
966
+ * methods: Property.setValues
967
+ * .setValues takes one parameter: an object containing paths to the values to be changed.
968
+ * It should be an object (or in the case of ArrayProperty, an array)
969
+ */
970
+ SET_VALUES_PARAM_NOT_OBJECT: string;
971
+ /**
972
+ * methods: PropertyFactory.create
973
+ * The array you tried to create had a typeid that was no recognized.
974
+ * It was not a custom type array or one of the following: ‘String’, ‘Int64’, ‘Uint64’ or ‘Bool’.
975
+ */
976
+ UNKNOWN_ARRAY_TYPEID: string;
977
+ /**
978
+ * methods: MapProperty.insert, MapProperty.set
979
+ * .insert and .set take two parameters. The first one is in_id (or in_key), which is the id under
980
+ * which the property is added. It can only be a string or a number. Only in the case of named
981
+ * property can it be omitted.
982
+ */
983
+ ID_STRING_OR_NUMBER: string;
984
+ /**
985
+ * methods: ValueProperty.deserialize
986
+ * .deserialize takes on parameter: a serialized object. It cannot be undefined.
987
+ */
988
+ DESERIALIZE_EMPTY_CHANGESET: string;
989
+ /**
990
+ * methods: IntMapProperty.insert, UintMapProperty.insert
991
+ * You tried to insert into a (u)Int64MapProperty or (u)Int64ArrayProperty properties that
992
+ * were not Int64 or UInt64 properties or properties that can be casted to the correct type.
993
+ */
994
+ INT_64_NON_INT64_TYPE: string;
995
+ /**
996
+ * methods: Integer64.toString, Integer64.fromString
997
+ */
998
+ BASE_OUT_OF_RANGE: string;
999
+ /**
1000
+ * methods: Integer64.fromString
1001
+ * If your property is an instance of Uint64, you cannot set it to a negative number.
1002
+ * Uint64 does not support negative numbers. Use Int64 if you need to support negative numbers.
1003
+ */
1004
+ CANNOT_UPDATE_TO_NEGATIVE: string;
1005
+ /**
1006
+ * methods: Integer64.fromString
1007
+ * The string you passed as a first parameter to .fromString contains non-numerical characters.
1008
+ */
1009
+ CANNOT_PARSE_INVALID_CHARACTERS: string;
1010
+ /**
1011
+ * methods: Property constructor
1012
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
1013
+ * Something went wrong while the property constructor was creating a property.
1014
+ * The parameters it received were not objects.
1015
+ */
1016
+ PROP_CONSTRUCTOR_EXPECTS_OBJECTS: string;
1017
+ /**
1018
+ * methods: Property.applyChangeSet
1019
+ * One of the ‘modify’ field in your changeset points to an index in the array that does not exist.
1020
+ * Check that the changeset you passed to applyChangeSet is valid. If you did not enter the changeSet yourself,
1021
+ * this is an internal error and you should contact the development team.
1022
+ */
1023
+ INDEX_INVALID: string;
1024
+ /**
1025
+ * methods: Property.isAncestorOf, Property.isDescendantOf
1026
+ * Property.isAncestorOf and .isDescendantOf take one parameter: a property. It cannot be undefined.
1027
+ */
1028
+ MISSING_IN_OTHERPROP: string;
1029
+ /**
1030
+ * methods: StringProperty.insert, StringProperty.push
1031
+ * StringProperty.insert takes two parameters: in_position and in_value.
1032
+ * The second one (in_value) must be a string.
1033
+ * StringProperty.push takes only one parameter (in_value), which must be a string.
1034
+ */
1035
+ IN_VALUE_MUST_BE_STRING: string;
1036
+ /**
1037
+ * methods: ValueProperty.getValues
1038
+ * You cannot use the method .getValues on value properties. getValues is used to get multiple nested
1039
+ * values from a custom property. To get the value of a primitive property, use .getValue instead.
1040
+ */
1041
+ NO_VALUE_PROPERTY_GETVALUES: string;
1042
+ /**
1043
+ * methods: Property.setValues, ArrayProperty.insertRange, ArrayProperty.removeRange,
1044
+ * ArrayProperty.setRange, EnumArrayProperty.setEnumByString, ArrayProperty.insert, ArrayProperty.set,
1045
+ * ArrayProperty.clear
1046
+ * If a property is created as a constant, it cannot be changed.
1047
+ */
1048
+ MODIFICATION_OF_CONSTANT_PROPERTY: string;
1049
+ /**
1050
+ * methods: ArrayProperty.insert, ArrayProperty.insertRange
1051
+ * In a non-primitive array, you can only insert instances of properties. You should use PropertyFactory.create
1052
+ * to create an instance of your property before inserting it into the array.
1053
+ */
1054
+ INSERT_NOT_A_PROP: string;
1055
+ /**
1056
+ * If a property is a reference, it cannot be changed.
1057
+ */
1058
+ MODIFICATION_OF_REFERENCED_PROPERTY: string;
1059
+ /**
1060
+ * methods: Property.getValue
1061
+ * Property.getValue(in_ids) is a shortcut for Property.get(in_ids).getValue().
1062
+ * Property.get(in_ids) must resolve to a ValueProperty.
1063
+ */
1064
+ GET_VALUE_NOT_A_VALUE: string;
1065
+ /**
1066
+ * methods: MapProperty.insert
1067
+ * If your map is not a ValueMap, in_property must be an instance of BaseProperty.
1068
+ * Use PropertyFactory.create to create an instance of a property.
1069
+ */
1070
+ NONVALUE_MAP_INSERT_PROP: string;
1071
+ /**
1072
+ * methods: PropertyFactory.create
1073
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
1074
+ * This error is thrown while creating a Property, when the actual context
1075
+ * ('array', 'map', 'set' or 'single') is different than what was expected.
1076
+ */
1077
+ CONTEXT_NOT_AS_EXPECTED: string;
1078
+ /**
1079
+ * methods: Property.deserialize
1080
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
1081
+ * This error is thrown by .deserialize but is caused by an invalid changeSet. A serialized ChangeSet for an
1082
+ * Integer64Property must be an array of 2 integers: the low and the high values. Since users cannot yet supply
1083
+ * their changesets directly, this should not happen.
1084
+ */
1085
+ INVALID_INT64_CHANGESET: string;
1086
+ /**
1087
+ * methods: StringProperty.set
1088
+ * StringProperty.set takes two parameters: in_index (a number, the index of the string that you wish to change)
1089
+ * and in_string (the string you want to insert at that index). To set the value of the whole string, use
1090
+ * setValue.
1091
+ */
1092
+ STRING_SET_NEEDS_INDEX: string;
1093
+ /**
1094
+ * methods: Property.get
1095
+ * The token DEREFERENCE_TOKEN should only be used with .get when the in_ids passed to .get is an array.
1096
+ * the DEREFERENCE_TOKEN should follow a path to a reference.
1097
+ * @example <caption>valid: </caption>
1098
+ * myProp.get(['myReference', TOKENS.DEREFERENCE_TOKEN])
1099
+ * @example <caption>not valid: </caption>
1100
+ * myProp.get('myReference').get(TOKENS.DEREFERENCE_TOKEN)
1101
+ */
1102
+ NO_GET_DEREFERENCE_ONLY: string;
1103
+ /**
1104
+ * methods: StringProperty.setValues
1105
+ * You cannot call .setValues on a StringProperty. To set the value of the string, use .setValue
1106
+ * instead.
1107
+ */
1108
+ NO_VALUE_PROPERTY_SETVALUES: string;
1109
+ /**
1110
+ * methods: Property.getRelativePath
1111
+ * In cases where you have more than one repository reference property pointing to the same repository, finding a path
1112
+ * between a properties in different repositories can lead to more than one valid results. In that case, .getRelativePath
1113
+ * will return the first valid path it finds. If you want to control how which path is used, you should construct the
1114
+ * string path by concatenating the absolute path for the prop in the nested repository and the relative path between your
1115
+ * repository reference and the target property.
1116
+ */
1117
+ MORE_THAN_ONE_PATH: string;
1118
+ /**
1119
+ * methods: Property.getRelativePath
1120
+ * getRelativePath takes one parameter: the property from which the path will start. This must be an instance of
1121
+ * BaseProperty. The method will return the path from that property to the property on which it was called ('this')
1122
+ */
1123
+ IN_FROMPROPERTY_MUST_BE_PROPERTY: string;
1124
+ /**
1125
+ * methods: Property.getRelativePath
1126
+ * getRelativePath does not return a path between a property that is inside a child repository to one that is in
1127
+ * a parent repository. A path like this could not be used with .resolvePath or be used in a reference property
1128
+ * because neither method can go from the root of a referenced repository to a reference property.
1129
+ */
1130
+ NO_PATH_FROM_CHILD_REPO: string;
1131
+ /**
1132
+ * methods: getReferencedWorkspace
1133
+ * This repository reference is in read-only mode. Call enableWrite() to access the workspace.
1134
+ */
1135
+ REPOSITORY_REFERENCE_WORKSPACE_READ_ONLY: string;
1136
+ /**
1137
+ * methods: Property.enableWrite
1138
+ * Repository reference is already in writable mode.
1139
+ */
1140
+ REPOSITORY_REFERENCE_WORKSPACE_EXIST_ALREADY: string;
1141
+ /**
1142
+ * methods: Property.enableWrite
1143
+ * Can't enable write on an empty repository reference without at least a repositoryGUID and branchGUID.
1144
+ */
1145
+ WRITABLE_REPOSITORY_REFERENCE_NEED_GUIDS: string;
1146
+ /**
1147
+ * methods: Property.enableWrite
1148
+ * Repository reference failed to automatically commit the new commitGUID.
1149
+ */
1150
+ WRITABLE_REPOSITORY_AUTO_COMMIT_FAIL: string;
1151
+ /**
1152
+ * methods: Property._setFollowBranch
1153
+ * An unexpected error occurred while trying to switch a repository reference followBranch property
1154
+ */
1155
+ WRITABLE_REPOSITORY_SET_FOLLOW_BRANCH_FAILED: string;
1156
+ /**
1157
+ * methods: MapProperty.insert, MapProperty.set
1158
+ * .insert and .set take two parameters. The first one is in_id (or in_key), which is the id under
1159
+ * which the property is added. It can not be an empty string.
1160
+ */
1161
+ ID_SHOULD_NOT_BE_EMPTY_STRING: string;
1162
+ /**
1163
+ * methods: StringProperty.set
1164
+ * StringProperty.set: in_character must have a length of 1.
1165
+ */
1166
+ STRING_SET_ONE_CHAR: string;
1167
+ /**
1168
+ * methods: EnumArrayProperty.set
1169
+ * EnumArrayProperty.set only accepts a string or number as input for in_value
1170
+ */
1171
+ VALUE_STRING_OR_NUMBER: string;
1172
+ /**
1173
+ * methods: ArrayProperty.set
1174
+ * The in_value input of ArrayProperty.set should not be an array.
1175
+ */
1176
+ ARRAY_SET_ONE_ELEMENT: string;
1177
+ CANT_DIRTY_MISSING_PROPERTY: string;
1178
+ /**
1179
+ * methods: MapProperty.insert, MapProperty.set, SetProperty.insert, NodeProperty.insert
1180
+ * The property you are trying to insert in your map property, set property or node property is a root.
1181
+ */
1182
+ INSERTED_ROOT_ENTRY: string;
1183
+ /**
1184
+ * methods: MapProperty.insert, MapProperty.set, SetProperty.insert, NodeProperty.insert
1185
+ * The property you are trying to insert in your map property, set property or node property is already
1186
+ * a parent of the map, set, or node property. You cannot insert this property there or you would create
1187
+ * a cycle in your data tree.
1188
+ */
1189
+ INSERTED_IN_OWN_CHILDREN: string;
1190
+ /**
1191
+ * methods: MapProperty.insert, MapProperty.set, SetProperty.insert, NodeProperty.insert
1192
+ * The property you are trying to insert (or at least one if its children) in your map property, set
1193
+ * property or node property is not covered by the paths of the partial checkout.
1194
+ * You cannot insert this property because you would not receive updates for this path after the
1195
+ * insertion and you could corrupt your data by doing subsequent modifications.
1196
+ */
1197
+ INSERTED_OUTSIDE_PATHS: string;
1198
+ SHARED_BEFORE_INSERTED: string;
1199
+ CUSTOM_ID_NOT_ALLOWED: string;
1200
+ /**
1201
+ * Context can only be ‘single’, ‘array’, ‘map’, ‘set’ or ‘enum’. All other values are invalid.
1202
+ */
1203
+ UNKNOWN_CONTEXT: string;
1204
+ /**
1205
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
1206
+ */
1207
+ ALREADY_EXISTING_ENTRY: string;
1208
+ /**
1209
+ * INTERNAL ERROR - If you encounter this error, please contact the development team.
1210
+ * The ChangeSet did not include an oldValue member which is computed when making the ChangeSet reversible.
1211
+ */
1212
+ OLD_VALUE_NOT_FOUND: string;
1213
+ CONTEXT_VALIDATION_IN_PROGRESS: string;
1214
+ NOT_A_VALID_CONTEXT: string;
1215
+ MISSING_PRE_POST_CALLBACK: string;
1216
+ };
1217
+ PROPERTY_PATH_DELIMITER: string;
1218
+ };
1219
+ //# sourceMappingURL=constants.d.ts.map