@particle-academy/monday-js 0.2.0 → 0.3.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 (3) hide show
  1. package/CHANGELOG.md +61 -0
  2. package/README.md +37 -0
  3. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -7,6 +7,65 @@ The four packages share one version, because they are generated from one
7
7
  `provider/` definition and a version that meant something different in each
8
8
  would be a version nobody could reason about.
9
9
 
10
+ ## [0.3.1] — 2026-08-24
11
+
12
+ ### Fixed
13
+
14
+ - **`@particle-academy/monday-js` now accepts a RANGE of `@particle-academy/monday-ui`, not one exact version.**
15
+
16
+ It peer-depended on `@particle-academy/monday-ui` at exactly the release it shipped with. That is the
17
+ strict form of the thing the kit's own rule forbids — a first-party sibling gets
18
+ a range — and the same block applied the rule correctly to its other two
19
+ dependencies. It was this one pair that slipped.
20
+
21
+ What it cost: ship `@particle-academy/monday-ui` with a fixed help string and every consumer on the
22
+ previous `@particle-academy/monday-js` had an **unmet peer**, which npm 7+ errors on. A documentation
23
+ patch could not be delivered without a matching runtime release, and a routine
24
+ `npm update` that moved the ui package alone broke the install.
25
+
26
+ The coupling is real and is not being loosened away. The ui package emits the
27
+ config schema and the js package implements against it, so a ui that adds a
28
+ field to a js that ignores it is silently wrong. But a PATCH is non-additive by
29
+ definition and a MINOR is where a field can appear — so `>=0.3.1 <0.4.0` is the
30
+ coupling that actually exists rather than the strictest one expressible.
31
+
32
+ Nothing else changed. `particle-academy/monday-php` and `fancy-monday` are unaffected; neither has an
33
+ equivalent edge.
34
+
35
+ ## [0.3.0] — 2026-08-24
36
+
37
+ ### Added
38
+
39
+ - **The README now says how to SET THIS CONNECTOR UP**, in the package itself.
40
+
41
+ Until now it explained what the four packages are, what they cost and why the
42
+ repo is generated — and said nothing about credentials, scopes, sandboxes or
43
+ operations. Somebody who installed it could not learn from it which credentials
44
+ a connection needs, where a human GETS them, which scopes to request, or what
45
+ the connector can actually do. All of that was already in the definition; the
46
+ one document a consumer reads was the one that omitted everything actionable.
47
+
48
+ The new **Setting it up** section carries:
49
+
50
+ - every credential, with the text saying where the value comes from, whether it
51
+ is **per installation** or **per connected account**, and whether it is secret;
52
+ - the OAuth authorize and token URLs and the exact scopes, verbatim;
53
+ - the access-token lifetime, and where refresh tokens ROTATE, the two things a
54
+ host must not do — retry a failed refresh, or refresh concurrently — because a
55
+ replay revokes the entire grant and nothing in the failure says why;
56
+ - the estate in this provider's own terms, including the cases where a
57
+ successful-looking run reaches nobody, or reaches the real one;
58
+ - every action and trigger with its method, path, inputs, and whether it is safe
59
+ to replay;
60
+ - a trigger's provider-side setup, which nobody can derive from anything else.
61
+
62
+ It is **generated from `provider/manifest.json`**, so it cannot drift from what
63
+ the packages do — which is the point at a few hundred providers, where a
64
+ hand-written setup section is a few hundred documents going quietly stale.
65
+
66
+ No code changed. This release exists because a registry and an installing agent
67
+ read the PUBLISHED artifact, and the artifact carried the old README.
68
+
10
69
  ## [0.2.0] — 2026-08-24
11
70
 
12
71
  ### Changed
@@ -101,3 +160,5 @@ is better than implying a guarantee the API cannot give.
101
160
 
102
161
  [0.1.0]: https://github.com/Fancy-Friends/monday/releases/tag/v0.1.0
103
162
  [0.2.0]: https://github.com/Fancy-Friends/monday/releases/tag/v0.2.0
163
+ [0.3.0]: https://github.com/Fancy-Friends/monday/releases/tag/v0.3.0
164
+ [0.3.1]: https://github.com/Fancy-Friends/monday/releases/tag/v0.3.1
package/README.md CHANGED
@@ -27,6 +27,43 @@ dependencies.
27
27
  subject to the kit's full approval bar, and one per provider is hundreds of
28
28
  dependencies nobody is tracking.
29
29
 
30
+ ## Setting it up
31
+
32
+ Everything below is generated from `provider/manifest.json`, so it cannot disagree with what the packages do.
33
+
34
+ ### Credentials
35
+
36
+ A monday.com connection holds 1 value.
37
+
38
+ Every value here is `account` scope: one per connected account, not one per installation.
39
+
40
+ | Field | Scope | Secret | Where it comes from |
41
+ |---|---|---|---|
42
+ | **API token** | per connected account | **secret** | From monday.com: your avatar -> Developers -> My Access Tokens. It carries YOUR permissions and every board you can see, so a personal token grants an automation everything you have. |
43
+
44
+ ### The estate
45
+
46
+ **monday.com has no test estate, and somebody checked.** Everything this connector does is real. Use the faker to build against it.
47
+
48
+ > monday has no test estate. A developer plan is a real account with real boards, so anything an action creates is created for real. The faker is the only safe way to develop against this connector, which is why every action ships with one.
49
+
50
+ ## What it can do
51
+
52
+ ### Actions
53
+
54
+ #### `item_create` — monday.com item
55
+
56
+ Create an item on a monday.com board.
57
+
58
+ `POST /v2` · **unsafe to replay** — a retried durable run does it TWICE
59
+
60
+ | Input | Required | What it is |
61
+ |---|---|---|
62
+ | `boardId` | yes | The numeric id in the board URL: monday.com/boards/1234567890. |
63
+ | `itemName` | yes | What the item is called on the board. |
64
+ | `groupId` | no | Which group on the board to create it in. Left empty, monday uses the board's default group. |
65
+ | `columnValues` | no | Column id to value, e.g. status -> Done. Which values a column accepts depends on its type. |
66
+
30
67
  ## Run it before you have credentials
31
68
 
32
69
  Every operation ships a **faker**, whether or not monday.com has a sandbox. Set a
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@particle-academy/monday-js",
3
- "version": "0.2.0",
3
+ "version": "0.3.1",
4
4
  "description": "monday.com for Node — the service descriptor, its faker, its webhook verification, and one function per operation. Plain HTTP on @particle-academy/fancy-connector-core; no vendor SDK.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -52,7 +52,7 @@
52
52
  },
53
53
  "peerDependencies": {
54
54
  "@particle-academy/fancy-flow": ">=0.47.1 <2.0",
55
- "@particle-academy/monday-ui": "0.2.0"
55
+ "@particle-academy/monday-ui": ">=0.3.0 <0.4.0"
56
56
  },
57
57
  "peerDependenciesMeta": {
58
58
  "@particle-academy/fancy-flow": {