@twin.org/core 0.0.4-next.1 → 0.0.4-next.10

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 (101) hide show
  1. package/dist/es/encoding/base64.js +2 -1
  2. package/dist/es/encoding/base64.js.map +1 -1
  3. package/dist/es/errors/conflictError.js +1 -1
  4. package/dist/es/errors/conflictError.js.map +1 -1
  5. package/dist/es/errors/generalError.js +1 -1
  6. package/dist/es/errors/generalError.js.map +1 -1
  7. package/dist/es/errors/notImplementedError.js +1 -1
  8. package/dist/es/errors/notImplementedError.js.map +1 -1
  9. package/dist/es/errors/validationError.js +1 -1
  10. package/dist/es/errors/validationError.js.map +1 -1
  11. package/dist/es/factories/factory.js +9 -0
  12. package/dist/es/factories/factory.js.map +1 -1
  13. package/dist/es/helpers/arrayHelper.js +1 -1
  14. package/dist/es/helpers/arrayHelper.js.map +1 -1
  15. package/dist/es/helpers/errorHelper.js +1 -1
  16. package/dist/es/helpers/errorHelper.js.map +1 -1
  17. package/dist/es/helpers/jsonHelper.js +1 -1
  18. package/dist/es/helpers/jsonHelper.js.map +1 -1
  19. package/dist/es/helpers/objectHelper.js +2 -2
  20. package/dist/es/helpers/objectHelper.js.map +1 -1
  21. package/dist/es/helpers/stringHelper.js +2 -2
  22. package/dist/es/helpers/stringHelper.js.map +1 -1
  23. package/dist/es/index.js +4 -0
  24. package/dist/es/index.js.map +1 -1
  25. package/dist/es/models/IComponent.js.map +1 -1
  26. package/dist/es/models/ILocale.js.map +1 -1
  27. package/dist/es/models/ISharedObjectBufferOptions.js +4 -0
  28. package/dist/es/models/ISharedObjectBufferOptions.js.map +1 -0
  29. package/dist/es/models/ISharedObjectBufferWorkerMessage.js +2 -0
  30. package/dist/es/models/ISharedObjectBufferWorkerMessage.js.map +1 -0
  31. package/dist/es/models/IValidationFailure.js.map +1 -1
  32. package/dist/es/models/sharedObjectBufferMessageTypes.js +13 -0
  33. package/dist/es/models/sharedObjectBufferMessageTypes.js.map +1 -0
  34. package/dist/es/utils/asyncCache.js +4 -1
  35. package/dist/es/utils/asyncCache.js.map +1 -1
  36. package/dist/es/utils/coerce.js +10 -20
  37. package/dist/es/utils/coerce.js.map +1 -1
  38. package/dist/es/utils/compression.js +1 -1
  39. package/dist/es/utils/compression.js.map +1 -1
  40. package/dist/es/utils/guards.js +36 -0
  41. package/dist/es/utils/guards.js.map +1 -1
  42. package/dist/es/utils/is.js +9 -9
  43. package/dist/es/utils/is.js.map +1 -1
  44. package/dist/es/utils/mutex.js +40 -11
  45. package/dist/es/utils/mutex.js.map +1 -1
  46. package/dist/es/utils/sharedObjectBuffer.js +305 -0
  47. package/dist/es/utils/sharedObjectBuffer.js.map +1 -0
  48. package/dist/es/utils/sharedStore.js +2 -2
  49. package/dist/es/utils/sharedStore.js.map +1 -1
  50. package/dist/types/errors/conflictError.d.ts +1 -1
  51. package/dist/types/errors/generalError.d.ts +1 -1
  52. package/dist/types/errors/notImplementedError.d.ts +1 -1
  53. package/dist/types/errors/validationError.d.ts +1 -1
  54. package/dist/types/factories/factory.d.ts +6 -0
  55. package/dist/types/helpers/arrayHelper.d.ts +1 -1
  56. package/dist/types/helpers/errorHelper.d.ts +1 -1
  57. package/dist/types/helpers/jsonHelper.d.ts +1 -1
  58. package/dist/types/helpers/objectHelper.d.ts +2 -2
  59. package/dist/types/helpers/stringHelper.d.ts +2 -2
  60. package/dist/types/index.d.ts +4 -0
  61. package/dist/types/models/IComponent.d.ts +2 -2
  62. package/dist/types/models/ILocale.d.ts +1 -1
  63. package/dist/types/models/ISharedObjectBufferOptions.d.ts +17 -0
  64. package/dist/types/models/ISharedObjectBufferWorkerMessage.d.ts +29 -0
  65. package/dist/types/models/IValidationFailure.d.ts +1 -1
  66. package/dist/types/models/sharedObjectBufferMessageTypes.d.ts +13 -0
  67. package/dist/types/utils/asyncCache.d.ts +1 -8
  68. package/dist/types/utils/coerce.d.ts +10 -20
  69. package/dist/types/utils/compression.d.ts +1 -1
  70. package/dist/types/utils/guards.d.ts +24 -0
  71. package/dist/types/utils/is.d.ts +9 -9
  72. package/dist/types/utils/sharedObjectBuffer.d.ts +74 -0
  73. package/dist/types/utils/sharedStore.d.ts +2 -2
  74. package/docs/changelog.md +225 -0
  75. package/docs/reference/classes/ArrayHelper.md +1 -1
  76. package/docs/reference/classes/AsyncCache.md +1 -1
  77. package/docs/reference/classes/Coerce.md +10 -50
  78. package/docs/reference/classes/Compression.md +1 -1
  79. package/docs/reference/classes/ConflictError.md +1 -1
  80. package/docs/reference/classes/ErrorHelper.md +1 -1
  81. package/docs/reference/classes/Factory.md +28 -0
  82. package/docs/reference/classes/GeneralError.md +1 -1
  83. package/docs/reference/classes/Guards.md +108 -0
  84. package/docs/reference/classes/Is.md +9 -9
  85. package/docs/reference/classes/JsonHelper.md +1 -1
  86. package/docs/reference/classes/NotImplementedError.md +1 -1
  87. package/docs/reference/classes/ObjectHelper.md +2 -2
  88. package/docs/reference/classes/SharedObjectBuffer.md +192 -0
  89. package/docs/reference/classes/SharedStore.md +2 -2
  90. package/docs/reference/classes/StringHelper.md +16 -13
  91. package/docs/reference/classes/ValidationError.md +1 -1
  92. package/docs/reference/index.md +5 -0
  93. package/docs/reference/interfaces/IComponent.md +2 -2
  94. package/docs/reference/interfaces/ILocale.md +1 -1
  95. package/docs/reference/interfaces/ISharedObjectBufferOptions.md +33 -0
  96. package/docs/reference/interfaces/ISharedObjectBufferWorkerMessage.md +44 -0
  97. package/docs/reference/interfaces/IValidationFailure.md +1 -1
  98. package/docs/reference/type-aliases/SharedObjectBufferMessageTypes.md +5 -0
  99. package/docs/reference/variables/SharedObjectBufferMessageTypes.md +13 -0
  100. package/locales/en.json +10 -2
  101. package/package.json +4 -4
@@ -0,0 +1,13 @@
1
+ # Variable: SharedObjectBufferMessageTypes
2
+
3
+ > `const` **SharedObjectBufferMessageTypes**: `object`
4
+
5
+ Message type constants for the SharedObjectBuffer worker-to-main-thread protocol.
6
+
7
+ ## Type Declaration
8
+
9
+ ### GetBuffer {#getbuffer}
10
+
11
+ > `readonly` **GetBuffer**: `"twin:sharedObjectBuffer:getBuffer"` = `"twin:sharedObjectBuffer:getBuffer"`
12
+
13
+ Worker requests the SharedArrayBuffer for a named object from the main thread.
package/locales/en.json CHANGED
@@ -55,6 +55,9 @@
55
55
  "bigint": "Property \"{property}\" must be a bigint, it is \"{value}\"",
56
56
  "boolean": "Property \"{property}\" must be a boolean, it is \"{value}\"",
57
57
  "date": "Property \"{property}\" must be a date, it is \"{value}\"",
58
+ "dateString": "Property \"{property}\" must be a date-only string in ISO 8601 format, it is \"{value}\"",
59
+ "dateTimeString": "Property \"{property}\" must be a date-time string in ISO 8601 format, it is \"{value}\"",
60
+ "timeString": "Property \"{property}\" must be a time string in ISO 8601 format, it is \"{value}\"",
58
61
  "timestampMilliseconds": "Property \"{property}\" must be a timestamp in milliseconds, it is \"{value}\"",
59
62
  "timestampSeconds": "Property \"{property}\" must be a timestamp in seconds, it is \"{value}\"",
60
63
  "objectUndefined": "Property \"{property}\" must be an object, it is \"undefined\"",
@@ -67,8 +70,8 @@
67
70
  "arrayEndsWith": "Property \"{property}\" must be an array ending with [{endValues}], it is \"{value}\"",
68
71
  "uint8Array": "Property \"{property}\" must be a Uint8Array, it is \"{value}\"",
69
72
  "function": "Property \"{property}\" must be a function, it is \"{value}\"",
70
- "urn": "Property \"{property}\" must be a Urn formatted string, it is \"{value}\"",
71
- "url": "Property \"{property}\" must be a Url formatted string, it is \"{value}\"",
73
+ "urn": "Property \"{property}\" must be a URN formatted string, it is \"{value}\"",
74
+ "url": "Property \"{property}\" must be a URL formatted string, it is \"{value}\"",
72
75
  "email": "Property \"{property}\" must be string in e-mail format, it is \"{value}\"",
73
76
  "uuidV7": "Property \"{property}\" must be a UUIDv7 formatted string, it is \"{value}\"",
74
77
  "uuidV7Compact": "Property \"{property}\" must be a UUIDv7 formatted string in compact mode, it is \"{value}\""
@@ -107,6 +110,11 @@
107
110
  "lockAlreadyReleased": "The key \"{key}\" is not currently locked",
108
111
  "lockTimeout": "Failed to acquire lock for key \"{key}\" within the timeout of {timeout} milliseconds",
109
112
  "bufferFetchFailed": "Failed to retrieve shared buffer for key \"{key}\" from the main thread"
113
+ },
114
+ "sharedObjectBuffer": {
115
+ "notCreated": "The shared buffer for object \"{objectId}\" has not been created",
116
+ "capacityExceeded": "The payload size of {required} bytes exceeds the maximum capacity of {capacity} bytes for object \"{objectId}\"",
117
+ "bufferFetchFailed": "Failed to retrieve shared buffer for object \"{objectId}\" from the main thread"
110
118
  }
111
119
  },
112
120
  "errorNames": {
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/core",
3
- "version": "0.0.4-next.1",
3
+ "version": "0.0.4-next.10",
4
4
  "description": "Helper methods/classes for data type checking/validation/guarding/error handling",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/iotaledger/framework.git",
7
+ "url": "git+https://github.com/iotaledger/twin-framework.git",
8
8
  "directory": "packages/core"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -14,7 +14,7 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/nameof": "0.0.4-next.1",
17
+ "@twin.org/nameof": "0.0.4-next.10",
18
18
  "intl-messageformat": "11.2.6",
19
19
  "rfc6902": "5.2.0"
20
20
  },
@@ -45,7 +45,7 @@
45
45
  "utilities"
46
46
  ],
47
47
  "bugs": {
48
- "url": "git+https://github.com/iotaledger/framework/issues"
48
+ "url": "git+https://github.com/iotaledger/twin-framework/issues"
49
49
  },
50
50
  "homepage": "https://twindev.org"
51
51
  }