@warp-drive-mirror/build-config 5.6.0-alpha.5 → 5.6.0-beta.1

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 (73) hide show
  1. package/declarations/-private/utils/deprecations.d.ts +5 -0
  2. package/declarations/-private/utils/features.d.ts +4 -0
  3. package/declarations/-private/utils/get-env.d.ts +8 -0
  4. package/declarations/-private/utils/logging.d.ts +9 -0
  5. package/declarations/babel-macros.d.ts +13 -0
  6. package/declarations/canary-features.d.ts +136 -0
  7. package/declarations/debugging.d.ts +172 -0
  8. package/declarations/deprecation-versions.d.ts +30 -0
  9. package/declarations/deprecations.d.ts +516 -0
  10. package/declarations/env.d.ts +129 -0
  11. package/declarations/index.d.ts +101 -0
  12. package/declarations/macros.d.ts +18 -0
  13. package/dist/addon-shim.cjs +0 -1
  14. package/dist/babel-macros.js +12 -13
  15. package/dist/babel-plugin-transform-asserts.cjs +3 -5
  16. package/dist/babel-plugin-transform-deprecations.cjs +0 -1
  17. package/dist/babel-plugin-transform-features.cjs +0 -1
  18. package/dist/babel-plugin-transform-logging.cjs +0 -1
  19. package/dist/{canary-features-DF5hbs2w.js → canary-features-CuKgaVtX.js} +18 -42
  20. package/dist/canary-features.js +1 -2
  21. package/dist/cjs-set-config.cjs +26 -47
  22. package/dist/debugging-VdsvkNjX.js +0 -1
  23. package/dist/debugging.js +0 -1
  24. package/dist/{deprecations-BVxAmwe9.js → deprecations-BNNGFAiG.js} +5 -6
  25. package/dist/deprecations.js +1 -2
  26. package/dist/env.js +0 -1
  27. package/dist/index.js +9 -7
  28. package/dist/macros.js +0 -1
  29. package/package.json +7 -16
  30. package/dist/addon-shim.cjs.map +0 -1
  31. package/dist/babel-macros.js.map +0 -1
  32. package/dist/babel-plugin-transform-asserts.cjs.map +0 -1
  33. package/dist/babel-plugin-transform-deprecations.cjs.map +0 -1
  34. package/dist/babel-plugin-transform-features.cjs.map +0 -1
  35. package/dist/babel-plugin-transform-logging.cjs.map +0 -1
  36. package/dist/canary-features-DF5hbs2w.js.map +0 -1
  37. package/dist/canary-features.js.map +0 -1
  38. package/dist/cjs-set-config.cjs.map +0 -1
  39. package/dist/debugging-VdsvkNjX.js.map +0 -1
  40. package/dist/debugging.js.map +0 -1
  41. package/dist/deprecations-BVxAmwe9.js.map +0 -1
  42. package/dist/deprecations.js.map +0 -1
  43. package/dist/env.js.map +0 -1
  44. package/dist/index.js.map +0 -1
  45. package/dist/macros.js.map +0 -1
  46. package/unstable-preview-types/-private/utils/deprecations.d.ts +0 -12
  47. package/unstable-preview-types/-private/utils/deprecations.d.ts.map +0 -1
  48. package/unstable-preview-types/-private/utils/features.d.ts +0 -9
  49. package/unstable-preview-types/-private/utils/features.d.ts.map +0 -1
  50. package/unstable-preview-types/-private/utils/get-env.d.ts +0 -11
  51. package/unstable-preview-types/-private/utils/get-env.d.ts.map +0 -1
  52. package/unstable-preview-types/-private/utils/logging.d.ts +0 -14
  53. package/unstable-preview-types/-private/utils/logging.d.ts.map +0 -1
  54. package/unstable-preview-types/babel-macros.d.ts +0 -16
  55. package/unstable-preview-types/babel-macros.d.ts.map +0 -1
  56. package/unstable-preview-types/canary-features.d.ts +0 -162
  57. package/unstable-preview-types/canary-features.d.ts.map +0 -1
  58. package/unstable-preview-types/cjs-set-config.d.ts +0 -4
  59. package/unstable-preview-types/cjs-set-config.d.ts.map +0 -1
  60. package/unstable-preview-types/debugging.d.ts +0 -175
  61. package/unstable-preview-types/debugging.d.ts.map +0 -1
  62. package/unstable-preview-types/deprecation-versions.d.ts +0 -16
  63. package/unstable-preview-types/deprecation-versions.d.ts.map +0 -1
  64. package/unstable-preview-types/deprecations.d.ts +0 -519
  65. package/unstable-preview-types/deprecations.d.ts.map +0 -1
  66. package/unstable-preview-types/env.d.ts +0 -132
  67. package/unstable-preview-types/env.d.ts.map +0 -1
  68. package/unstable-preview-types/index.d.ts +0 -113
  69. package/unstable-preview-types/index.d.ts.map +0 -1
  70. package/unstable-preview-types/macros.d.ts +0 -21
  71. package/unstable-preview-types/macros.d.ts.map +0 -1
  72. package/unstable-preview-types/validate-exports.type-test.d.ts +0 -4
  73. package/unstable-preview-types/validate-exports.type-test.d.ts.map +0 -1
@@ -1,162 +0,0 @@
1
- declare module '@warp-drive-mirror/build-config/canary-features' {
2
- /**
3
- *
4
- * # Canary Features <Badge type="warning" text="requires canary" />
5
- *
6
- * ***Warp*Drive** allows users to test upcoming features that are implemented
7
- * but not yet activated in canary builds.
8
- *
9
- * Typically these features represent work that carries higher risk of breaking
10
- * changes, or are not yet fully ready for production use.
11
- *
12
- * Such features have their implementations guarded by a "feature flag", and the
13
- * flag is only activated once the core-data team is prepared to ship the work
14
- * in a canary release, beginning the process of it landing in a stable release.
15
- *
16
- * ### Installing Canary
17
- *
18
- * ::: warning To test a feature guarded behind a flag, you MUST be using a canary build.
19
- * :::
20
- *
21
- * Canary builds are published to `npm` and can be installed using a precise tag
22
- * (such as `@warp-drive/core@5.6.0-alpha.1`) or by installing the latest dist-tag
23
- * published to the `canary` channel.
24
- *
25
- * Because ***Warp*Drive** packages operate on a strict lockstep policy with each other,
26
- * you must install the matching canary version of all ***Warp*Drive** packages.
27
- *
28
- * Below is an example of installing the latest canary version of all the primary
29
- * packages that are part of the ***Warp*Drive** project. Add/remove packages from
30
- * this list to match your project.
31
- *
32
- * ::: code-group
33
- *
34
- * ```sh [pnpm]
35
- * pnpm add -E @ember-data-mirror/store@canary \
36
- * @ember-data-mirror/json-api@canary \
37
- * @ember-data-mirror/debug@canary \
38
- * @ember-data-mirror/graph@canary \
39
- * @ember-data-mirror/request@canary \
40
- * @ember-data-mirror/request-utils@canary \
41
- * @warp-drive-mirror/schema-record@canary \
42
- * @warp-drive-mirror/build-config@canary \
43
- * @warp-drive-mirror/core-types@canary;
44
- * ```
45
- *
46
- * ```sh [npm]
47
- * npm add -E @ember-data-mirror/store@canary \
48
- * @ember-data-mirror/json-api@canary \
49
- * @ember-data-mirror/debug@canary \
50
- * @ember-data-mirror/graph@canary \
51
- * @ember-data-mirror/request@canary \
52
- * @ember-data-mirror/request-utils@canary \
53
- * @warp-drive-mirror/schema-record@canary \
54
- * @warp-drive-mirror/build-config@canary \
55
- * @warp-drive-mirror/core-types@canary;
56
- * ```
57
- *
58
- * ```sh [yarn]
59
- * yarn add -E @ember-data-mirror/store@canary \
60
- * @ember-data-mirror/json-api@canary \
61
- * @ember-data-mirror/debug@canary \
62
- * @ember-data-mirror/graph@canary \
63
- * @ember-data-mirror/request@canary \
64
- * @ember-data-mirror/request-utils@canary \
65
- * @warp-drive-mirror/schema-record@canary \
66
- * @warp-drive-mirror/build-config@canary \
67
- * @warp-drive-mirror/core-types@canary;
68
- * ```
69
- *
70
- * ```sh [bun]
71
- * bun add --exact @ember-data-mirror/store@canary \
72
- * @ember-data-mirror/json-api@canary \
73
- * @ember-data-mirror/debug@canary \
74
- * @ember-data-mirror/graph@canary \
75
- * @ember-data-mirror/request@canary \
76
- * @ember-data-mirror/request-utils@canary \
77
- * @warp-drive-mirror/schema-record@canary \
78
- * @warp-drive-mirror/build-config@canary \
79
- * @warp-drive-mirror/core-types@canary;
80
- * ```
81
- *
82
- * :::
83
- *
84
- * ### Activating a Feature
85
- *
86
- * Once you have installed canary, feature-flags can be activated at build-time
87
- *
88
- * ```ts
89
- * setConfig(app, __dirname, {
90
- * features: {
91
- * FEATURE_A: false, // utilize existing behavior
92
- * FEATURE_B: true // utilize the new behavior
93
- * }
94
- * })
95
- * ```
96
- *
97
- * by setting an environment variable:
98
- *
99
- * ```sh
100
- * # Activate a single flag
101
- * export WARP_DRIVE_FEATURE_OVERRIDE=SOME_FLAG;
102
- *
103
- * # Activate multiple flags by separating with commas
104
- * export WARP_DRIVE_FEATURE_OVERRIDE=SOME_FLAG,OTHER_FLAG;
105
- *
106
- * # Activate all flags
107
- * export WARP_DRIVE_FEATURE_OVERRIDE=ENABLE_ALL_OPTIONAL;
108
- * ```
109
- *
110
- * ::: warning To test a feature guarded behind a flag, you MUST be running a development build.
111
- * :::
112
- *
113
- *
114
- * ### Preparing a Project to use a Canary Feature
115
- *
116
- * For most projects and features, simple version detection should be enough.
117
- *
118
- * Using the provided version compatibility helpers from [embroider-macros](https://github.com/embroider-build/embroider/tree/main/packages/macros#readme)
119
- * the following can be done:
120
- *
121
- * ```js
122
- * if (macroCondition(dependencySatisfies('@ember-data-mirror/store', '5.0'))) {
123
- * // do thing
124
- * }
125
- * ```
126
- *
127
- * For more complex projects and migrations, configure [@warp-drive-mirror/build-config/babel-macros](./babel-macros)
128
- *
129
- * The current list of features used at build time for canary releases is defined below.
130
- *
131
- * ::: tip 💡 If empty there are no features currently gated by feature flags.
132
- * :::
133
- *
134
- * The valid values are:
135
- *
136
- * - `true` | The feature is **enabled** at all times, and cannot be disabled.
137
- * - `false` | The feature is **disabled** at all times, and cannot be enabled.
138
- * - `null` | The feature is **disabled by default**, but can be enabled via configuration.
139
- *
140
- * @module
141
- * @public
142
- */
143
- /**
144
- * We use this for some tests etc.
145
- *
146
- * @internal
147
- */
148
- export const SAMPLE_FEATURE_FLAG: boolean | null;
149
- /**
150
- * This upcoming feature adds a validation step to payloads received
151
- * by the JSONAPICache implementation.
152
- *
153
- * When a request completes and the result is given to the cache via
154
- * `cache.put`, the cache will validate the payload against registered
155
- * schemas as well as the JSON:API spec.
156
- *
157
- * @since 5.4
158
- * @public
159
- */
160
- export const JSON_API_CACHE_VALIDATION_ERRORS: boolean | null;
161
- }
162
- //# sourceMappingURL=canary-features.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"canary-features.d.ts","sourceRoot":"","sources":["../src/canary-features.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4IG;AAEH;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,EAAE,OAAO,GAAG,IAAW,CAAC;AAExD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gCAAgC,EAAE,OAAO,GAAG,IAAY,CAAC"}
@@ -1,4 +0,0 @@
1
- declare module '@warp-drive-mirror/build-config/cjs-set-config' {
2
- export { setConfig } from '@warp-drive-mirror/build-config/index.ts';
3
- }
4
- //# sourceMappingURL=cjs-set-config.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"cjs-set-config.d.ts","sourceRoot":"","sources":["../src/cjs-set-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC"}
@@ -1,175 +0,0 @@
1
- declare module '@warp-drive-mirror/build-config/debugging' {
2
- /**
3
- * # Log Instrumentation <Badge type="tip" text="debug only" />
4
- *
5
- * Many portions of the internals are helpfully instrumented with logging.
6
- * This instrumentation is always removed from production builds.
7
- *
8
- * Log instrumentation is "regionalized" to specific concepts and concerns
9
- * to enable you to enable/disable just the areas you are interested in.
10
- *
11
- * To activate a particular group of logs set the appropriate flag to `true`
12
- * either in your build config or via the runtime helper.
13
- *
14
- *
15
- * ## Runtime Activation
16
- *
17
- * ::: tip 💡 Just Works in browser Dev Tools!
18
- * No import is needed, and the logging config is preserved when the page is refreshed
19
- * :::
20
- *
21
- * ```ts
22
- * setWarpDriveLogging({
23
- * LOG_CACHE: true,
24
- * LOG_REQUESTS: true,
25
- * })
26
- * ```
27
- *
28
- * A runtime helper is attached to `globalThis` to enable activation of the logs
29
- * from anywhere in your application including from the devtools panel.
30
- *
31
- * The runtime helper overrides any build config settings for the given flag
32
- * for the current browser tab. It stores the configuration you give it in
33
- * `sessionStorage` so that it persists across page reloads of the current tab,
34
- * but not across browser tabs or windows.
35
- *
36
- * If you need to deactivate the logging, you can call the helper again with the
37
- * same flag set to `false` or just open a new tab/window.
38
- *
39
- * ## Buildtime Activation
40
- *
41
- * ```ts
42
- * setConfig(__dirname, app, {
43
- * debug: {
44
- * LOG_CACHE: true,
45
- * LOG_REQUESTS: false,
46
- * LOG_NOTIFICATIONS: true,
47
- * }
48
- * });
49
- * ```
50
- *
51
- * The build config settings are used to set the default values for the
52
- * logging flags. Any logging flag that is not set in the build config
53
- * will default to `false`.
54
- *
55
- * @module
56
- */
57
- /**
58
- * log cache updates for both local
59
- * and remote state. Note in some older versions
60
- * this was called `LOG_PAYLOADS` and was one
61
- * of three flags that controlled logging of
62
- * cache updates. This is now the only flag.
63
- *
64
- * The others were `LOG_OPERATIONS` and `LOG_MUTATIONS`.
65
- *
66
- * @public
67
- * @since 5.5
68
- */
69
- export const LOG_CACHE: boolean;
70
- /**
71
- * <Badge type="danger" text="removed" />
72
- *
73
- * This flag no longer has any effect.
74
- *
75
- * Use {@link LOG_CACHE} instead.
76
- *
77
- * @deprecated removed in version 5.5
78
- * @public
79
- */
80
- export const LOG_PAYLOADS: boolean;
81
- /**
82
- * <Badge type="danger" text="removed" />
83
- *
84
- * This flag no longer has any effect.
85
- *
86
- * Use {@link LOG_CACHE} instead.
87
- *
88
- * @deprecated removed in version 5.5
89
- * @public
90
- */
91
- export const LOG_OPERATIONS: boolean;
92
- /**
93
- * <Badge type="danger" text="removed" />
94
- *
95
- * This flag no longer has any effect.
96
- *
97
- * Use {@link LOG_CACHE} instead.
98
- *
99
- * @deprecated removed in version 5.5
100
- * @public
101
- */
102
- export const LOG_MUTATIONS: boolean;
103
- /**
104
- * Log decisions made by the Basic CachePolicy
105
- *
106
- * @public
107
- */
108
- export const LOG_CACHE_POLICY: boolean;
109
- /**
110
- * log notifications received by the NotificationManager
111
- *
112
- * @public
113
- */
114
- export const LOG_NOTIFICATIONS: boolean;
115
- /**
116
- * log requests issued by the RequestManager
117
- *
118
- * @public
119
- */
120
- export const LOG_REQUESTS: boolean;
121
- /**
122
- * log updates to requests the store has issued to
123
- * the network (adapter) to fulfill.
124
- *
125
- * @public
126
- */
127
- export const LOG_REQUEST_STATUS: boolean;
128
- /**
129
- * log peek, generation and updates to
130
- * Record Identifiers.
131
- *
132
-
133
- * @public
134
- */
135
- export const LOG_IDENTIFIERS: boolean;
136
- /**
137
- * log updates received by the graph (relationship pointer storage)
138
- *
139
- * @public
140
- */
141
- export const LOG_GRAPH: boolean;
142
- /**
143
- * log creation/removal of RecordData and Record
144
- * instances.
145
- *
146
- * @public
147
- */
148
- export const LOG_INSTANCE_CACHE: boolean;
149
- /**
150
- * Log key count metrics, useful for performance
151
- * debugging.
152
- *
153
- * @public
154
- */
155
- export const LOG_METRIC_COUNTS: boolean;
156
- /**
157
- * Helps when debugging causes of a change notification
158
- * when processing an update to a hasMany relationship.
159
- *
160
- * @public
161
- */
162
- export const DEBUG_RELATIONSHIP_NOTIFICATIONS: boolean;
163
- /**
164
- * A private flag to enable logging of the native Map/Set
165
- * constructor and method calls.
166
- *
167
- * EXTREMELY MALPERFORMANT
168
- *
169
- * LOG_METRIC_COUNTS must also be enabled.
170
- *
171
- * @internal
172
- */
173
- export const __INTERNAL_LOG_NATIVE_MAP_SET_COUNTS: boolean;
174
- }
175
- //# sourceMappingURL=debugging.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"debugging.d.ts","sourceRoot":"","sources":["../src/debugging.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,SAAS,EAAE,OAAe,CAAC;AAExC;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,EAAE,OAAe,CAAC;AAE3C;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,EAAE,OAAe,CAAC;AAE7C;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,EAAE,OAAe,CAAC;AAE5C;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAAe,CAAC;AAE/C;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,OAAe,CAAC;AAChD;;;;GAIG;AACH,eAAO,MAAM,YAAY,EAAE,OAAe,CAAC;AAC3C;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,EAAE,OAAe,CAAC;AACjD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,EAAE,OAAe,CAAC;AAC9C;;;;GAIG;AACH,eAAO,MAAM,SAAS,EAAE,OAAe,CAAC;AACxC;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,EAAE,OAAe,CAAC;AACjD;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,EAAE,OAAe,CAAC;AAChD;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,EAAE,OAAe,CAAC;AAE/D;;;;;;;;;GASG;AACH,eAAO,MAAM,oCAAoC,EAAE,OAAe,CAAC"}
@@ -1,16 +0,0 @@
1
- declare module '@warp-drive-mirror/build-config/deprecation-versions' {
2
- export const DEPRECATE_CATCH_ALL = "99.0";
3
- export const DEPRECATE_NON_STRICT_TYPES = "5.3";
4
- export const DEPRECATE_NON_STRICT_ID = "5.3";
5
- export const DEPRECATE_COMPUTED_CHAINS = "7.0";
6
- export const DEPRECATE_LEGACY_IMPORTS = "5.3";
7
- export const DEPRECATE_NON_UNIQUE_PAYLOADS = "5.3";
8
- export const DEPRECATE_RELATIONSHIP_REMOTE_UPDATE_CLEARING_LOCAL_STATE = "5.3";
9
- export const DEPRECATE_MANY_ARRAY_DUPLICATES = "5.3";
10
- export const DEPRECATE_STORE_EXTENDS_EMBER_OBJECT = "5.4";
11
- export const ENABLE_LEGACY_SCHEMA_SERVICE = "5.4";
12
- export const DEPRECATE_EMBER_INFLECTOR = "5.3";
13
- export const DISABLE_7X_DEPRECATIONS = "7.0";
14
- export const DEPRECATE_TRACKING_PACKAGE = "5.5";
15
- }
16
- //# sourceMappingURL=deprecation-versions.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"deprecation-versions.d.ts","sourceRoot":"","sources":["../src/deprecation-versions.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,mBAAmB,SAAS,CAAC;AAC1C,eAAO,MAAM,0BAA0B,QAAQ,CAAC;AAChD,eAAO,MAAM,uBAAuB,QAAQ,CAAC;AAC7C,eAAO,MAAM,yBAAyB,QAAQ,CAAC;AAC/C,eAAO,MAAM,wBAAwB,QAAQ,CAAC;AAC9C,eAAO,MAAM,6BAA6B,QAAQ,CAAC;AACnD,eAAO,MAAM,yDAAyD,QAAQ,CAAC;AAC/E,eAAO,MAAM,+BAA+B,QAAQ,CAAC;AACrD,eAAO,MAAM,oCAAoC,QAAQ,CAAC;AAC1D,eAAO,MAAM,4BAA4B,QAAQ,CAAC;AAClD,eAAO,MAAM,yBAAyB,QAAQ,CAAC;AAC/C,eAAO,MAAM,uBAAuB,QAAQ,CAAC;AAC7C,eAAO,MAAM,0BAA0B,QAAQ,CAAC"}