@merkur/integration 0.46.0 → 1.0.3
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.
- package/README.md +67 -22
- package/lib/index.umd.js +1 -1
- package/package.json +4 -7
package/README.md
CHANGED
|
@@ -38,8 +38,42 @@ To check out [live demo](https://merkur.js.org/demo) and [docs](https://merkur.j
|
|
|
38
38
|
|
|
39
39
|
Contribute to this project via [Pull-Requests](https://github.com/mjancarik/merkur/pulls).
|
|
40
40
|
|
|
41
|
-
We are
|
|
41
|
+
We are using [Changesets](https://github.com/changesets/changesets) for versioning and releasing. To add a changeset describing your changes, run `npm run changeset`.
|
|
42
42
|
|
|
43
|
+
> **Note:** The release process is documented **only** in this root README. Any per-package README sections that still describe a Lerna/Conventional Commits–based release flow are outdated and should be ignored in favour of the instructions below.
|
|
44
|
+
|
|
45
|
+
### Changeset format
|
|
46
|
+
|
|
47
|
+
Each changeset file (`.changeset/*.md`) must follow this structure:
|
|
48
|
+
|
|
49
|
+
**Frontmatter** — standard Changesets YAML listing affected package names and bump types (`patch`, `minor`, `major`).
|
|
50
|
+
|
|
51
|
+
**First line after frontmatter** — a single brief sentence summarising the change. No heading, no bold, no trailing bullet — just a plain declarative sentence. This section is not required but helps to quickly understand the change when browsing the changesets.
|
|
52
|
+
|
|
53
|
+
**Body** — three bullet points in this exact order, with no blank lines between them:
|
|
54
|
+
|
|
55
|
+
- **What** One or more sentences describing what changed: which APIs, files, or behaviours were added, removed, or fixed. Make sublists if needed to break down complex changes, but keep each bullet point as a single paragraph.
|
|
56
|
+
- **Why** One or more sentences explaining the motivation: why the change was necessary or beneficial.
|
|
57
|
+
- **How** Migration steps for consumers or contributors. If no action is required, write exactly: `Nothing.`
|
|
58
|
+
|
|
59
|
+
Additional rules:
|
|
60
|
+
- Each bullet is a single paragraph — no nested lists, no code blocks inside a bullet.
|
|
61
|
+
- Do not use headings (`##`, `###`) inside the body.
|
|
62
|
+
- Code symbols (function names, paths, package names) use backtick inline code.
|
|
63
|
+
|
|
64
|
+
Example:
|
|
65
|
+
|
|
66
|
+
```markdown
|
|
67
|
+
---
|
|
68
|
+
"@merkur/example": minor
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
Add `createFoo` helper for simplified widget initialisation.
|
|
72
|
+
|
|
73
|
+
- **What** New `createFoo(options)` export in `@merkur/example` wraps the low-level `initFoo` call and applies sensible defaults for `name` and `version`.
|
|
74
|
+
- **Why** Every project was duplicating the same boilerplate to call `initFoo`; centralising it reduces setup friction and ensures consistent defaults.
|
|
75
|
+
- **How** Replace direct `initFoo` calls with `createFoo({ name, version })`. The returned object is API-compatible, so no further changes are needed.
|
|
76
|
+
```
|
|
43
77
|
|
|
44
78
|
### Release
|
|
45
79
|
|
|
@@ -48,32 +82,43 @@ To release a version you must have the right permissions, please contact one of
|
|
|
48
82
|
|
|
49
83
|
#### Regular version release
|
|
50
84
|
|
|
51
|
-
To do a regular release,
|
|
85
|
+
To do a regular release, from the `master` branch with no uncommitted changes, run:
|
|
52
86
|
|
|
53
87
|
```
|
|
54
88
|
npm run release
|
|
55
89
|
```
|
|
56
90
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
91
|
+
This runs `release:prepare` (applies pending changesets, bumps versions, updates `package-lock.json`) followed by `release:push` (commits, tags, and pushes to the repository).
|
|
92
|
+
|
|
93
|
+
Packages are published from a GitHub Action triggered when a new version tag is pushed.
|
|
94
|
+
|
|
95
|
+
#### RC (pre-release) release
|
|
96
|
+
|
|
97
|
+
1. Enter pre-release mode (only needs to be done once per RC cycle):
|
|
98
|
+
```
|
|
99
|
+
npm run release:next:init
|
|
100
|
+
```
|
|
101
|
+
This sets pre-release mode to `rc`, so subsequent version bumps produce `rc` versions (e.g. `v0.44.0-rc.0`).
|
|
102
|
+
|
|
103
|
+
2. Add a changeset describing your changes:
|
|
104
|
+
```
|
|
105
|
+
npm run changeset
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
3. Bump versions and push the RC release:
|
|
109
|
+
```
|
|
110
|
+
npm run release
|
|
111
|
+
```
|
|
112
|
+
Repeat steps 2–3 for each subsequent RC iteration (e.g. `rc.0 → rc.1`).
|
|
113
|
+
|
|
114
|
+
4. When ready to graduate to a stable release, exit pre-release mode and prepare the final version:
|
|
115
|
+
```
|
|
116
|
+
npm run release:graduate
|
|
117
|
+
```
|
|
118
|
+
Then push with:
|
|
119
|
+
```
|
|
120
|
+
npm run release:push
|
|
121
|
+
```
|
|
77
122
|
|
|
78
123
|
---
|
|
79
124
|
|
package/lib/index.umd.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
!function(e,t){if("function"==typeof define&&define.amd)define("@merkur/integration",["exports"],t);else if("undefined"!=typeof exports)t(exports);else{var r={exports:{}};t(r.exports),e.Merkur=e.Merkur||{},e.Merkur.Integration=r.exports}}("undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:this,
|
|
1
|
+
!function(e,t){if("function"==typeof define&&define.amd)define("@merkur/integration",["exports"],t);else if("undefined"!=typeof exports)t(exports);else{var r={exports:{}};t(r.exports),e.Merkur=e.Merkur||{},e.Merkur.Integration=r.exports}}("undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:this,function(e){function t(e){return t="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t(e)}function r(e,t,r,n,o,i,u){try{var s=e[i](u),c=s.value}catch(e){return void r(e)}s.done?t(c):Promise.resolve(c).then(n,o)}function n(e){return function(){var t=this,n=arguments;return new Promise(function(o,i){var u=e.apply(t,n);function s(e){r(u,o,i,s,c,"next",e)}function c(e){r(u,o,i,s,c,"throw",e)}s(void 0)})}}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter(function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable})),r.push.apply(r,n)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach(function(t){u(e,t,r[t])}):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach(function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))})}return e}function u(e,r,n){return(r=function(e){var r=function(e,r){if("object"!=t(e)||!e)return e;var n=e[Symbol.toPrimitive];if(void 0!==n){var o=n.call(e,r||"default");if("object"!=t(o))return o;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===r?String:Number)(e)}(e,"string");return"symbol"==t(r)?r:r+""}(r))in e?Object.defineProperty(e,r,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[r]=n,e}var s,c,a,l;Object.defineProperty(e,"__esModule",{value:!0}),e.isLoadedSymbol=void 0,e.loadAssets=function(e,t){return x.apply(this,arguments)},e.loadJsonAssets=E,e.loadScriptAssets=g,e.loadStyleAssets=b,e.testScript=e.loadingPromiseSymbol=void 0;var f=e.testScript={isES9Supported:function(){return void 0===s&&(s=f.test("return (() => { const o = { t: 1 }; return { ...o }; })() && (async () => ({}))()")&&!!Object.values),s},isES11Supported:function(){return void 0===c&&(c=f.test("return (() => { const o = { t: { q: true } }; return o?.t?.q && (o?.a?.q ?? true); })()")&&f.test('return typeof Promise.allSettled === "function"')&&f.test('return typeof globalThis !== "undefined"')&&f.test('return typeof 9007199254740991n === "bigint"')),c},isES13Supported:function(){return void 0===a&&(a=f.test("return [1,1].findLast(e => e === 1)")&&f.test('return Object.hasOwn({a:1}, "a")')),a},isES15Supported:function(){return void 0===l&&(l=f.test('return typeof Promise.withResolvers === "function"')&&f.test('return typeof Object.groupBy === "function"')),l},test:function(e){try{return!!new Function(e)()}catch(e){return!1}}},p=e.isLoadedSymbol=Symbol.for("isLoaded"),d=e.loadingPromiseSymbol=Symbol.for("loadingPromise");function y(e,t){return i(i({},e),{},{element:t})}function m(e){var t=e.asset,r=e.message,n=void 0===r?"Error loading asset ".concat(t.source,"."):r;if(t.optional)return console.warn(n),y(t,null);var o=new Error(n);throw o.asset=t,o}function v(e,t,r,n){t.addEventListener("load",function(){r(y(e,t)),t[p]=!0,delete t[d]}),t.addEventListener("error",function(){t.parentNode&&t.remove();try{r(m({asset:e}))}catch(e){n(e)}})}function b(e){return h.apply(this,arguments)}function h(){return h=n(function*(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:document.head,r=Array.from(t.querySelectorAll("style"));return Promise.all(e.map(function(e){if(!["stylesheet","inlineStyle"].includes(e.type)||!e.source)return y(e,null);if("stylesheet"===e.type){var n=t.querySelector("link[href='".concat(e.source,"']"));if(n)return n[d]?n[d]:y(e,n)}if("inlineStyle"===e.type){var o=r.find(function(t){return t.innerHTML===e.source});if(o)return y(e,o)}return function(e,t){if("inlineStyle"===e.type){var r=document.createElement("style");return r.dataset.merkurAssetName=e.name,r.innerHTML=e.source,t.appendChild(r),y(e,r)}var n=document.createElement("link");return n[d]=new Promise(function(r,o){v(e,n,r,o),n.rel="stylesheet",n.dataset.merkurAssetName=e.name,n.href=e.source,t.appendChild(n)}),n[d]}(e,t)}))}),h.apply(this,arguments)}function S(e,t){if("json"===t.type)return e.find(function(e){return e.dataset.src===t.source});if(!["script","inlineScript","inlineJson"].includes(t.type))return null;var r="script"===t.type?"src":"textContent",n="inlineJson"===t.type?JSON.stringify(t.source):t.source;return e.find(function(e){return e[r]===n})||null}function g(e){return O.apply(this,arguments)}function O(){return O=n(function*(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:document.head,r=Array.from(t.querySelectorAll("script"));return Promise.all(e.map(function(e){if(!["script","inlineScript"].includes(e.type)||!e.source)return y(e,null);e.module&&e.attr&&!1!==e.attr.defer&&(e=i(i({},e),{},{attr:i(i({},e.attr),{},{defer:!1})}));var n=e.source,o=Object.assign({},e);if(n===Object(n)&&(n.es13&&f.isES13Supported()?o.source=n.es13:n.es11&&f.isES11Supported()?o.source=n.es11:n.es9&&f.isES9Supported()?o.source=n.es9:o.source=null,!o.source))return m({asset:o,message:"Asset '".concat(o.name,"' is missing ES variant and could not be loaded.")});if(o.test&&f.test(o.test))return y(o,S(r,o));var u=S(r,o);return u&&"script"===o.type?u[d]?u[d]:u[p]?y(o,u):new Promise(function(e,t){return v(o,u,e,t)}):u&&"inlineScript"===o.type?y(o,u):function(e,t){var r=document.createElement("script");return r.dataset.merkurAssetName=e.name,e.module&&(r.type="module"),"inlineScript"===e.type?(r.textContent=e.source,t.appendChild(r),y(e,r)):(r[d]=new Promise(function(n,o){e.module||(r.defer=!0),v(e,r,n,o),r.src=e.source;var i=e.attr;if(i&&Object.keys(i).length)for(var u in i){var s=i[u];"boolean"==typeof s?s?r.setAttribute(u,""):r.removeAttribute(u):r.setAttribute(u,s)}t.appendChild(r)}),r[d])}(o,t)}))}),O.apply(this,arguments)}function P(){return(P=n(function*(e){var t=yield fetch(e);if(!t.ok)throw new Error("Failed to fetch from '".concat(e,"' with status ").concat(t.status," ").concat(t.statusText,"."));return t.text()})).apply(this,arguments)}function j(e,t){t&&setTimeout(function(){e.parentNode&&e.remove()},t)}function w(e,t){var r=document.createElement("script");return r.dataset.merkurAssetName=e.name,r.type="application/json","inlineJson"===e.type?(r.textContent=JSON.stringify(e.source),t.appendChild(r),j(r,e.ttl),y(e,r)):(r[d]=new Promise(function(o,i){r.dataset.src=e.source,t.appendChild(r),n(function*(){try{var t=yield function(e){return P.apply(this,arguments)}(e.source);r.textContent=t,delete r[d],j(r,e.ttl),o(y(e,r))}catch(t){r.remove();try{o(m({asset:e,message:"Error loading JSON asset '".concat(e.name,"': ").concat(t.message)}))}catch(e){i(e)}}})()}),r[d])}function E(e){return A.apply(this,arguments)}function A(){return A=n(function*(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:document.head,r=Array.from(t.querySelectorAll('script[type="application/json"]'));return Promise.all(e.map(function(e){if(!["json","inlineJson"].includes(e.type)||!e.source)return y(e,null);var n=S(r,e);return n?n[d]?n[d]:n.textContent?y(e,n):m({asset:e,message:"JSON asset '".concat(e.name,"' is missing textContent and could not be loaded.")}):w(e,t)}))}),A.apply(this,arguments)}function x(){return(x=n(function*(e,t){return function(e){return e.reduce(function(e,t){return t.forEach(function(t,r){e[r]?t.element&&(e[r]=t):e[r]=t}),e},[])}(yield Promise.all([g(e,t),b(e,t),E(e,t)]))})).apply(this,arguments)}});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@merkur/integration",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "Merkur module for easy integration with other apps.",
|
|
5
5
|
"main": "lib/index",
|
|
6
6
|
"module": "lib/index",
|
|
@@ -25,11 +25,9 @@
|
|
|
25
25
|
"./lib/index.es9.mjs": "./lib/index.es9.mjs"
|
|
26
26
|
},
|
|
27
27
|
"scripts": {
|
|
28
|
-
"preversion": "npm test",
|
|
29
28
|
"test": "jest --no-watchman -c ./jest.config.js",
|
|
30
29
|
"test:es:version": "es-check es11 ./lib/index.mjs --module && es-check es9 ./lib/index.es9.mjs --module && es-check es9 ./lib/index.es9.cjs --module",
|
|
31
|
-
"build": "rollup -c rollup.config.mjs"
|
|
32
|
-
"postpublish": "node ../../utils/restoreLatestTag.mjs"
|
|
30
|
+
"build": "rollup -c rollup.config.mjs"
|
|
33
31
|
},
|
|
34
32
|
"repository": {
|
|
35
33
|
"type": "git",
|
|
@@ -50,10 +48,9 @@
|
|
|
50
48
|
},
|
|
51
49
|
"homepage": "https://merkur.js.org/",
|
|
52
50
|
"devDependencies": {
|
|
53
|
-
"@merkur/core": "^0.
|
|
51
|
+
"@merkur/core": "^1.0.0"
|
|
54
52
|
},
|
|
55
53
|
"peerDependencies": {
|
|
56
54
|
"@merkur/core": "*"
|
|
57
|
-
}
|
|
58
|
-
"gitHead": "87b662ef7cd7a84fc1724023607ef2cbbae2c811"
|
|
55
|
+
}
|
|
59
56
|
}
|