@particle-academy/youtube-js 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -4,6 +4,40 @@ All notable changes to `@particle-academy/youtube-ui`,
 `@particle-academy/youtube-js`, `particle-academy/youtube-php` and
 `fancy-youtube`.
 
+## [0.2.0] — 2026-08-24
+
+### Added
+
+- **The README now says how to SET THIS CONNECTOR UP**, in the package itself.
+
+Until now it explained what the four packages are, what they cost and why the
+repo is generated — and said nothing about credentials, scopes, sandboxes or
+operations. Somebody who installed it could not learn from it which credentials
+a connection needs, where a human GETS them, which scopes to request, or what
+the connector can actually do. All of that was already in the definition; the
+one document a consumer reads was the one that omitted everything actionable.
+
+The new **Setting it up** section carries:
+
+- every credential, with the text saying where the value comes from, whether it
+  is **per installation** or **per connected account**, and whether it is secret;
+- the OAuth authorize and token URLs and the exact scopes, verbatim;
+- the access-token lifetime, and where refresh tokens ROTATE, the two things a
+  host must not do — retry a failed refresh, or refresh concurrently — because a
+  replay revokes the entire grant and nothing in the failure says why;
+- the estate in this provider's own terms, including the cases where a
+  successful-looking run reaches nobody, or reaches the real one;
+- every action and trigger with its method, path, inputs, and whether it is safe
+  to replay;
+- a trigger's provider-side setup, which nobody can derive from anything else.
+
+It is **generated from `provider/manifest.json`**, so it cannot drift from what
+the packages do — which is the point at a few hundred providers, where a
+hand-written setup section is a few hundred documents going quietly stale.
+
+No code changed. This release exists because a registry and an installing agent
+read the PUBLISHED artifact, and the artifact carried the old README.
+
 ## [0.1.0] — 2026-08-23
 
 First release.
@@ -27,3 +61,4 @@ accepts for modifying playlist contents. YouTube has no test estate, and
 `playlistItems.insert` has no idempotency key; a retry can add the video twice.
 
 [0.1.0]: https://github.com/Fancy-Friends/youtube/releases/tag/v0.1.0
+[0.2.0]: https://github.com/Fancy-Friends/youtube/releases/tag/v0.2.0

package/README.md

@@ -27,6 +27,55 @@ dependencies.
 subject to the kit's full approval bar, and one per provider is hundreds of
 dependencies nobody is tracking.
 
+## Setting it up
+
+Everything below is generated from `provider/manifest.json`, so it cannot disagree with what the packages do.
+
+### Credentials
+
+A YouTube connection holds 4 values.
+
+**Two kinds of value, and mixing them up matters.** A `provider` credential is ONE value for the whole installation — an OAuth app's client secret serves every connected account. An `account` credential is one per connected account. A host that stores the second where it stores the first lets one account's credentials reach another's.
+
+| Field | Scope | Secret | Where it comes from |
+|---|---|---|---|
+| **OAuth client ID** | per installation | not secret | From Google Cloud Console. One value for the whole installation. |
+| **OAuth client secret** | per installation | **secret** | The client secret for the same OAuth app. |
+| **Access token** | per connected account | **secret** | Per connected YouTube account; expires after one hour. |
+| **Refresh token** | per connected account | **secret** | Per connected YouTube account; the host uses it to refresh the access token. |
+
+### Authorising
+
+YouTube uses OAuth2 (authorization_code). The package DECLARES the exchange; the HOST performs it — a consent screen needs a browser, a redirect URI and somewhere to persist the result, and all three belong to the host.
+
+- **Authorize URL** — https://accounts.google.com/o/oauth2/v2/auth
+- **Token URL** — https://oauth2.googleapis.com/token
+- **Scopes** — `https://www.googleapis.com/auth/youtube.force-ssl`
+- **Access token lifetime** — 3600 seconds (1 hours). A host that never refreshes works all afternoon and is broken by morning.
+
+The refresh tokens do **not** rotate: the same one is reusable, so a refresh may safely be retried and may run concurrently. Stated rather than assumed, because the opposite — a provider that spends the token and revokes the grant on a replay — looks identical until it happens.
+
+### The estate
+
+**YouTube has no test estate, and somebody checked.** Everything this connector does is real. Use the faker to build against it.
+
+> YouTube has no sandbox. Every live-mode add changes a real playlist; use the faker during development and remove live test items afterward.
+
+## What it can do
+
+### Actions
+
+#### `playlist_item_insert` — YouTube playlist item
+
+Add a video to a YouTube playlist.
+
+`POST /youtube/v3/playlistItems` · **unsafe to replay** — a retried durable run does it TWICE
+
+| Input | Required | What it is |
+|---|---|---|
+| `playlistId` | yes | The YouTube id of the playlist to add the video to. |
+| `videoId` | yes | The YouTube id of the video to add. |
+
 ## Run it before you have credentials
 
 Every operation ships a **faker**, whether or not YouTube has a sandbox. Set a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@particle-academy/youtube-js",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "YouTube 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.",
   "repository": {
     "type": "git",
@@ -52,7 +52,7 @@
   },
   "peerDependencies": {
     "@particle-academy/fancy-flow": ">=0.47.1 <2.0",
-    "@particle-academy/youtube-ui": "0.1.0"
+    "@particle-academy/youtube-ui": "0.2.0"
   },
   "peerDependenciesMeta": {
     "@particle-academy/fancy-flow": {