@particle-academy/monday-js 0.1.0 → 0.3.0

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 +7 -4
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.0] — 2026-08-24
11
+
12
+ ### Added
13
+
14
+ - **The README now says how to SET THIS CONNECTOR UP**, in the package itself.
15
+
16
+ Until now it explained what the four packages are, what they cost and why the
17
+ repo is generated — and said nothing about credentials, scopes, sandboxes or
18
+ operations. Somebody who installed it could not learn from it which credentials
19
+ a connection needs, where a human GETS them, which scopes to request, or what
20
+ the connector can actually do. All of that was already in the definition; the
21
+ one document a consumer reads was the one that omitted everything actionable.
22
+
23
+ The new **Setting it up** section carries:
24
+
25
+ - every credential, with the text saying where the value comes from, whether it
26
+ is **per installation** or **per connected account**, and whether it is secret;
27
+ - the OAuth authorize and token URLs and the exact scopes, verbatim;
28
+ - the access-token lifetime, and where refresh tokens ROTATE, the two things a
29
+ host must not do — retry a failed refresh, or refresh concurrently — because a
30
+ replay revokes the entire grant and nothing in the failure says why;
31
+ - the estate in this provider's own terms, including the cases where a
32
+ successful-looking run reaches nobody, or reaches the real one;
33
+ - every action and trigger with its method, path, inputs, and whether it is safe
34
+ to replay;
35
+ - a trigger's provider-side setup, which nobody can derive from anything else.
36
+
37
+ It is **generated from `provider/manifest.json`**, so it cannot drift from what
38
+ the packages do — which is the point at a few hundred providers, where a
39
+ hand-written setup section is a few hundred documents going quietly stale.
40
+
41
+ No code changed. This release exists because a registry and an installing agent
42
+ read the PUBLISHED artifact, and the artifact carried the old README.
43
+
44
+ ## [0.2.0] — 2026-08-24
45
+
46
+ ### Changed
47
+
48
+ - **`@particle-academy/monday-ui` is now an OPTIONAL PEER dependency of `@particle-academy/monday-js`, not a hard one.**
49
+
50
+ `./flow` needs it; nothing else does. It was a hard dependency, and because
51
+ `@particle-academy/monday-ui` itself peer-depends on `fancy-flow` — which npm 7+ installs
52
+ automatically — `npm install @particle-academy/monday-js` pulled the **entire flow engine**
53
+ onto disk for a consumer who only wanted to call the API. Roughly **18 MB
54
+ became 874 KB**, and the package works exactly as before:
55
+
56
+ ```js
57
+ import { monday… } from "@particle-academy/monday-js";
58
+ // an injected transport, no flow engine anywhere
59
+ ```
60
+
61
+ **This is breaking if you use `@particle-academy/monday-js/flow`.** Add `@particle-academy/monday-ui` to your own
62
+ dependencies — it was always being installed for you, and now it is declared.
63
+ Everything importing only the main entry point is unaffected.
64
+
65
+ The fix is on this edge rather than on `@particle-academy/monday-ui` → `fancy-flow`: the ui package
66
+ genuinely requires fancy-flow, since it calls `defineConnectorKind`, and marking
67
+ that peer optional would be a lie about what it needs.
68
+
10
69
  ## [0.1.0] — 2026-08-22
11
70
 
12
71
  First release. Provider seven, and the first that is not REST.
@@ -75,3 +134,5 @@ safe, and a retried durable run creates a **second item**. Saying that plainly
75
134
  is better than implying a guarantee the API cannot give.
76
135
 
77
136
  [0.1.0]: https://github.com/Fancy-Friends/monday/releases/tag/v0.1.0
137
+ [0.2.0]: https://github.com/Fancy-Friends/monday/releases/tag/v0.2.0
138
+ [0.3.0]: https://github.com/Fancy-Friends/monday/releases/tag/v0.3.0
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.1.0",
3
+ "version": "0.3.0",
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",
@@ -48,15 +48,18 @@
48
48
  "prepublishOnly": "tsup"
49
49
  },
50
50
  "dependencies": {
51
- "@particle-academy/fancy-connector-core": ">=0.3.1 <2.0",
52
- "@particle-academy/monday-ui": "0.1.0"
51
+ "@particle-academy/fancy-connector-core": ">=0.3.1 <2.0"
53
52
  },
54
53
  "peerDependencies": {
55
- "@particle-academy/fancy-flow": ">=0.47.1 <2.0"
54
+ "@particle-academy/fancy-flow": ">=0.47.1 <2.0",
55
+ "@particle-academy/monday-ui": "0.3.0"
56
56
  },
57
57
  "peerDependenciesMeta": {
58
58
  "@particle-academy/fancy-flow": {
59
59
  "optional": true
60
+ },
61
+ "@particle-academy/monday-ui": {
62
+ "optional": true
60
63
  }
61
64
  },
62
65
  "devDependencies": {