@effect/platform-browser 4.0.0-beta.98 → 4.0.0-rc.108

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 (137) hide show
  1. package/AGENTS.md +381 -0
  2. package/CLAUDE.md +381 -0
  3. package/README.md +14 -1
  4. package/ai-docs/README.md +44 -0
  5. package/ai-docs/package.json +36 -0
  6. package/ai-docs/src/01_effect/01_basics/01_effect-gen.ts +30 -0
  7. package/ai-docs/src/01_effect/01_basics/02_effect-fn.ts +39 -0
  8. package/ai-docs/src/01_effect/01_basics/10_creating-effects.ts +74 -0
  9. package/ai-docs/src/01_effect/01_basics/index.md +5 -0
  10. package/ai-docs/src/01_effect/02_schema/10_schema-basics.ts +43 -0
  11. package/ai-docs/src/01_effect/02_schema/index.md +7 -0
  12. package/ai-docs/src/01_effect/03_services/01_service.ts +45 -0
  13. package/ai-docs/src/01_effect/03_services/10_reference.ts +10 -0
  14. package/ai-docs/src/01_effect/03_services/20_layer-composition.ts +70 -0
  15. package/ai-docs/src/01_effect/03_services/20_layer-unwrap.ts +66 -0
  16. package/ai-docs/src/01_effect/03_services/index.md +5 -0
  17. package/ai-docs/src/01_effect/04_errors/01_error-handling.ts +30 -0
  18. package/ai-docs/src/01_effect/04_errors/10_catch-tags.ts +24 -0
  19. package/ai-docs/src/01_effect/04_errors/20_reason-errors.ts +64 -0
  20. package/ai-docs/src/01_effect/04_errors/index.md +1 -0
  21. package/ai-docs/src/01_effect/05_resources/10_acquire-release.ts +105 -0
  22. package/ai-docs/src/01_effect/05_resources/20_layer-side-effects.ts +31 -0
  23. package/ai-docs/src/01_effect/05_resources/30_layer-map.ts +86 -0
  24. package/ai-docs/src/01_effect/05_resources/index.md +3 -0
  25. package/ai-docs/src/01_effect/06_running/10_run-main.ts +30 -0
  26. package/ai-docs/src/01_effect/06_running/20_layer-launch.ts +27 -0
  27. package/ai-docs/src/01_effect/06_running/index.md +1 -0
  28. package/ai-docs/src/01_effect/07_pubsub/10_pubsub.ts +56 -0
  29. package/ai-docs/src/01_effect/07_pubsub/index.md +3 -0
  30. package/ai-docs/src/03_stream/10_creating-streams.ts +103 -0
  31. package/ai-docs/src/03_stream/20_consuming-streams.ts +137 -0
  32. package/ai-docs/src/03_stream/30_encoding.ts +165 -0
  33. package/ai-docs/src/03_stream/index.md +4 -0
  34. package/ai-docs/src/04_integration/10_managed-runtime.ts +129 -0
  35. package/ai-docs/src/04_integration/index.md +5 -0
  36. package/ai-docs/src/05_batching/10_request-resolver.ts +89 -0
  37. package/ai-docs/src/05_batching/index.md +3 -0
  38. package/ai-docs/src/06_schedule/10_schedules.ts +110 -0
  39. package/ai-docs/src/06_schedule/index.md +3 -0
  40. package/ai-docs/src/07_datetime/10_creating-and-formatting.ts +30 -0
  41. package/ai-docs/src/07_datetime/20_time-zones.ts +44 -0
  42. package/ai-docs/src/07_datetime/index.md +5 -0
  43. package/ai-docs/src/08_observability/10_logging.ts +66 -0
  44. package/ai-docs/src/08_observability/20_otlp-tracing.ts +95 -0
  45. package/ai-docs/src/08_observability/index.md +7 -0
  46. package/ai-docs/src/09_testing/10_effect-tests.ts +55 -0
  47. package/ai-docs/src/09_testing/20_layer-tests.ts +138 -0
  48. package/ai-docs/src/09_testing/index.md +1 -0
  49. package/ai-docs/src/10_predicate/01_basics.ts +14 -0
  50. package/ai-docs/src/10_predicate/index.md +9 -0
  51. package/ai-docs/src/50_http-client/10_basics.ts +102 -0
  52. package/ai-docs/src/50_http-client/index.md +3 -0
  53. package/ai-docs/src/51_http-server/10_basics.ts +116 -0
  54. package/ai-docs/src/51_http-server/fixtures/api/Api.ts +14 -0
  55. package/ai-docs/src/51_http-server/fixtures/api/Authorization.ts +36 -0
  56. package/ai-docs/src/51_http-server/fixtures/api/System.ts +10 -0
  57. package/ai-docs/src/51_http-server/fixtures/api/Users.ts +91 -0
  58. package/ai-docs/src/51_http-server/fixtures/domain/User.ts +12 -0
  59. package/ai-docs/src/51_http-server/fixtures/domain/UserErrors.ts +22 -0
  60. package/ai-docs/src/51_http-server/fixtures/server/Authorization.ts +36 -0
  61. package/ai-docs/src/51_http-server/fixtures/server/Users/http.ts +71 -0
  62. package/ai-docs/src/51_http-server/fixtures/server/Users.ts +62 -0
  63. package/ai-docs/src/51_http-server/index.md +3 -0
  64. package/ai-docs/src/60_child-process/10_working-with-child-processes.ts +117 -0
  65. package/ai-docs/src/60_child-process/index.md +3 -0
  66. package/ai-docs/src/70_cli/10_basics.ts +136 -0
  67. package/ai-docs/src/70_cli/index.md +5 -0
  68. package/ai-docs/src/71_ai/10_language-model.ts +156 -0
  69. package/ai-docs/src/71_ai/20_tools.ts +226 -0
  70. package/ai-docs/src/71_ai/30_chat.ts +158 -0
  71. package/ai-docs/src/71_ai/fixtures/domain/LaunchPlan.ts +9 -0
  72. package/ai-docs/src/71_ai/index.md +5 -0
  73. package/ai-docs/src/80_cluster/10_entities.ts +97 -0
  74. package/ai-docs/src/80_cluster/index.md +4 -0
  75. package/ai-docs/src/index.md +10 -0
  76. package/ai-docs/tsconfig.json +24 -0
  77. package/dist/BrowserCrypto.d.ts +1 -1
  78. package/dist/BrowserCrypto.d.ts.map +1 -1
  79. package/dist/BrowserCrypto.js +4 -2
  80. package/dist/BrowserCrypto.js.map +1 -1
  81. package/dist/BrowserHttpClient.d.ts +5 -5
  82. package/dist/BrowserHttpClient.d.ts.map +1 -1
  83. package/dist/BrowserHttpClient.js +12 -7
  84. package/dist/BrowserHttpClient.js.map +1 -1
  85. package/dist/BrowserKeyValueStore.d.ts.map +1 -1
  86. package/dist/BrowserKeyValueStore.js +38 -9
  87. package/dist/BrowserKeyValueStore.js.map +1 -1
  88. package/dist/BrowserPersistence.js.map +1 -1
  89. package/dist/BrowserRuntime.d.ts +3 -3
  90. package/dist/BrowserRuntime.js +1 -1
  91. package/dist/BrowserRuntime.js.map +1 -1
  92. package/dist/BrowserSocket.js.map +1 -1
  93. package/dist/BrowserStream.d.ts +2 -2
  94. package/dist/BrowserStream.js +2 -2
  95. package/dist/BrowserStream.js.map +1 -1
  96. package/dist/BrowserWorker.js.map +1 -1
  97. package/dist/BrowserWorkerRunner.d.ts.map +1 -1
  98. package/dist/BrowserWorkerRunner.js +2 -1
  99. package/dist/BrowserWorkerRunner.js.map +1 -1
  100. package/dist/Clipboard.d.ts +1 -1
  101. package/dist/Clipboard.js.map +1 -1
  102. package/dist/Geolocation.d.ts +1 -1
  103. package/dist/Geolocation.js.map +1 -1
  104. package/dist/IndexedDb.d.ts +3 -3
  105. package/dist/IndexedDb.d.ts.map +1 -1
  106. package/dist/IndexedDb.js +2 -2
  107. package/dist/IndexedDb.js.map +1 -1
  108. package/dist/IndexedDbDatabase.d.ts +3 -3
  109. package/dist/IndexedDbDatabase.d.ts.map +1 -1
  110. package/dist/IndexedDbDatabase.js +13 -7
  111. package/dist/IndexedDbDatabase.js.map +1 -1
  112. package/dist/IndexedDbQueryBuilder.d.ts +9 -9
  113. package/dist/IndexedDbQueryBuilder.d.ts.map +1 -1
  114. package/dist/IndexedDbQueryBuilder.js +38 -13
  115. package/dist/IndexedDbQueryBuilder.js.map +1 -1
  116. package/dist/IndexedDbTable.d.ts +9 -9
  117. package/dist/IndexedDbTable.js.map +1 -1
  118. package/dist/IndexedDbVersion.d.ts +4 -4
  119. package/dist/IndexedDbVersion.js.map +1 -1
  120. package/dist/Permissions.d.ts +1 -1
  121. package/dist/Permissions.js.map +1 -1
  122. package/dist/index.js.map +1 -1
  123. package/package.json +12 -13
  124. package/src/BrowserCrypto.ts +4 -2
  125. package/src/BrowserHttpClient.ts +11 -7
  126. package/src/BrowserKeyValueStore.ts +50 -8
  127. package/src/BrowserRuntime.ts +3 -3
  128. package/src/BrowserStream.ts +2 -2
  129. package/src/BrowserWorkerRunner.ts +2 -1
  130. package/src/Clipboard.ts +1 -1
  131. package/src/Geolocation.ts +1 -1
  132. package/src/IndexedDb.ts +3 -3
  133. package/src/IndexedDbDatabase.ts +15 -9
  134. package/src/IndexedDbQueryBuilder.ts +64 -21
  135. package/src/IndexedDbTable.ts +9 -9
  136. package/src/IndexedDbVersion.ts +4 -4
  137. package/src/Permissions.ts +1 -1
@@ -23,7 +23,7 @@ const TypeId = "~@effect/platform-browser/IndexedDbTable"
23
23
  /**
24
24
  * Typed IndexedDB table definition containing its name, schema, key path, indexes, auto-increment setting, and transaction durability.
25
25
  *
26
- * @category interface
26
+ * @category models
27
27
  * @since 4.0.0
28
28
  */
29
29
  export interface IndexedDbTable<
@@ -94,14 +94,14 @@ export type AnyWithProps = IndexedDbTable<
94
94
  /**
95
95
  * Extracts the table name type from an `IndexedDbTable`.
96
96
  *
97
- * @category models
97
+ * @category utility types
98
98
  * @since 4.0.0
99
99
  */
100
100
  export type TableName<Table extends Any> = Table["tableName"]
101
101
  /**
102
102
  * Extracts the key-path type from an `IndexedDbTable`.
103
103
  *
104
- * @category models
104
+ * @category utility types
105
105
  * @since 4.0.0
106
106
  */
107
107
  export type KeyPath<Table extends Any> = Table["keyPath"]
@@ -109,7 +109,7 @@ export type KeyPath<Table extends Any> = Table["keyPath"]
109
109
  /**
110
110
  * Extracts the auto-increment flag type from an `IndexedDbTable`.
111
111
  *
112
- * @category models
112
+ * @category utility types
113
113
  * @since 4.0.0
114
114
  */
115
115
  export type AutoIncrement<Table extends Any> = Table["autoIncrement"]
@@ -117,14 +117,14 @@ export type AutoIncrement<Table extends Any> = Table["autoIncrement"]
117
117
  /**
118
118
  * Extracts the schema type from an `IndexedDbTable`.
119
119
  *
120
- * @category models
120
+ * @category utility types
121
121
  * @since 4.0.0
122
122
  */
123
123
  export type TableSchema<Table extends Any> = Table["tableSchema"]
124
124
  /**
125
125
  * Extracts the decoding or encoding service requirements needed by an `IndexedDbTable` schema.
126
126
  *
127
- * @category models
127
+ * @category utility types
128
128
  * @since 4.0.0
129
129
  */
130
130
  export type Context<Table extends Any> =
@@ -134,7 +134,7 @@ export type Context<Table extends Any> =
134
134
  /**
135
135
  * Extracts the encoded row type from an `IndexedDbTable` schema.
136
136
  *
137
- * @category models
137
+ * @category utility types
138
138
  * @since 4.0.0
139
139
  */
140
140
  export type Encoded<Table extends Any> = Table["tableSchema"]["Encoded"]
@@ -142,7 +142,7 @@ export type Encoded<Table extends Any> = Table["tableSchema"]["Encoded"]
142
142
  /**
143
143
  * Extracts the index definition map from an `IndexedDbTable`.
144
144
  *
145
- * @category models
145
+ * @category utility types
146
146
  * @since 4.0.0
147
147
  */
148
148
  export type Indexes<Table extends Any> = Table["indexes"]
@@ -150,7 +150,7 @@ export type Indexes<Table extends Any> = Table["indexes"]
150
150
  /**
151
151
  * Selects the table with the given name from a union of `IndexedDbTable` types.
152
152
  *
153
- * @category models
153
+ * @category utility types
154
154
  * @since 4.0.0
155
155
  */
156
156
  export type WithName<Table extends Any, TableName extends string> = Extract<
@@ -27,7 +27,7 @@ const TypeId = "~@effect/platform-browser/IndexedDbVersion"
27
27
  /**
28
28
  * Typed IndexedDB version definition containing the tables available in that schema version.
29
29
  *
30
- * @category interface
30
+ * @category models
31
31
  * @since 4.0.0
32
32
  */
33
33
  export interface IndexedDbVersion<
@@ -59,7 +59,7 @@ export type AnyWithProps = IndexedDbVersion<IndexedDbTable.AnyWithProps>
59
59
  /**
60
60
  * Extracts the table union from an `IndexedDbVersion`.
61
61
  *
62
- * @category models
62
+ * @category utility types
63
63
  * @since 4.0.0
64
64
  */
65
65
  export type Tables<Db extends Any> = Db extends IndexedDbVersion<infer _Tables> ? _Tables : never
@@ -67,7 +67,7 @@ export type Tables<Db extends Any> = Db extends IndexedDbVersion<infer _Tables>
67
67
  /**
68
68
  * Selects a table by name from an `IndexedDbVersion`.
69
69
  *
70
- * @category models
70
+ * @category utility types
71
71
  * @since 4.0.0
72
72
  */
73
73
  export type TableWithName<
@@ -78,7 +78,7 @@ export type TableWithName<
78
78
  /**
79
79
  * Extracts the schema for a named table within an `IndexedDbVersion`.
80
80
  *
81
- * @category models
81
+ * @category utility types
82
82
  * @since 4.0.0
83
83
  */
84
84
  export type SchemaWithName<
@@ -21,7 +21,7 @@ const ErrorTypeId = "~@effect/platform-browser/Permissions/PermissionsError"
21
21
  * Wrapper on the Permission API (`navigator.permissions`) with methods for
22
22
  * querying status of permissions.
23
23
  *
24
- * @category models
24
+ * @category services
25
25
  * @since 4.0.0
26
26
  */
27
27
  export interface Permissions {