@volter/twin-linkedin 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,39 @@
+# `@volter/twin-linkedin` — an organization's posts on LinkedIn
+
+An organization's **company page** on LinkedIn: its posts (commentary with one video, one image or an
+article) through the versioned Posts API, the Images and Videos upload protocols behind them, the
+page's admin roles and follower count, and a linkedin.com-style company page to preview each post as
+linkedin.com shows it before a deploy sends it — offline, against local state.
+
+```bash
+bun packages/twin/linkedin/src/cli.ts serve --root /tmp/world     # the API
+bun packages/twin/linkedin/src/cli.ts mirror --root /tmp/world    # the company page, on the same state
+```
+
+Every `/rest` call needs `Linkedin-Version` (`202510` … `202609`) and a bearer the world seeded; the
+official client (`linkedin-api-client`) reaches it through the hosts on the descriptor.
+
+## Coverage
+
+| Area | What the twin serves |
+|---|---|
+| `POST /rest/posts` | Create an **organization post**: `author`, `commentary`, `visibility`, `distribution`, `lifecycleState: PUBLISHED`; `content.media` naming an AVAILABLE image or video the page owns, or `content.article` (`source`, `title`, `description`, an optional thumbnail image). 201 with the URN in `x-restli-id` and no body. A `#hashtag` is stored as LinkedIn answers it, the little-format template `{hashtag\|\\#\|tag}`. Missing fields are `MISSING_FIELD`, values outside the documented enums `INVALID_VALUE_FOR_FIELD`, media not yet uploaded or failed processing the Videos API's own codes (`MEDIA_ASSET_WAITING_UPLOAD`, `MEDIA_ASSET_PROCESSING_FAILED`), another page's media 403 `ACCESS_DENIED`. |
+| `GET /rest/posts/{urn}` · `GET /rest/posts?ids=List(…)` · `GET /rest/posts?q=author` | Read a post (by the URN it was created under, even after a deploy re-keyed it to LinkedIn's) (the Post schema, times in ms), batch get (`results` / `statuses` / `errors`), and the author finder: newest first by `CREATED` or `LAST_MODIFIED`, `start`/`count` (10, at most 100) with the vendor's `next` link. |
+| `DELETE /rest/posts/{urn}` | Idempotent 204; the post leaves every read. |
+| `POST /rest/images?action=initializeUpload` + the upload `PUT` | An image upload: a `/dms-uploads/…` URL signed with the asset's own secret, whose PUT needs the URL's signature **and** the member's token (ADMINISTRATOR or DIRECT_SPONSORED_CONTENT_POSTER on the page, as the Images and Videos pages require of an upload); JPG, GIF or PNG, sized from its own bytes, then `AVAILABLE`. |
+| `POST /rest/videos?action=initializeUpload` · part `PUT`s · `action=finalizeUpload` · `GET /rest/videos/{urn}` | A video upload as LinkedIn documents it: 4 MB byte-range upload instructions on signed URLs (no bearer), an ETag per part, finalize with the ETags in order, an optional thumbnail upload, then `PROCESSING` until two seconds of world time after finalize, `AVAILABLE` after — a fold of the stored instant and the request's own, so reading (a preview included) never moves it. **A frozen World clock keeps a video PROCESSING**: advance the clock (`volter world clock advance 2s`) for it to become AVAILABLE. A World finishes only the uploads it started: a part, thumbnail or finalize for an asset its origin or parent initialized is refused (409, "finish it there") and writes nothing; reads of it are unchanged. A file outside the feed's bounds (3 s–30 min, at least 75,000 bytes — the Videos API's "Between 75kb and 500MB", decimal as written — MP4) fails processing with its reason; a declared size over the feed's 500 MB is refused by name at initialize (the ads videos up to 5 GB are not modelled). |
+| asset bytes | Served under the twin's base at LinkedIn's own path shapes — `/dms/image/<asset>/…` and `/playlist/<asset>/…` — through the kernel's ranged reads with HTTP Range (206/416): an open-ended range is capped at 8 MiB, and a whole file or a long range is streamed in 8 MiB reads. A video with no uploaded thumbnail answers a stand-in poster: the twin decodes no frames. |
+| `GET /rest/organizationAcls` · `GET /rest/organizations/{id}` · `?q=vanityName` · `GET /rest/organizationsLookup?ids=List(…)` · `GET /rest/networkSizes/{org}` | The member's roles (`q=roleAssignee`) and a page's (`q=organization`), the administered page, the public lookups by vanity name and by id, and the follower count. |
+| `GET /v2/userinfo` | The token's member (OpenID Connect), used by the mirror's sign-in. |
+| errors | `{status, code, message}`; the two version errors quoted from LinkedIn's docs (`VERSION_MISSING`, `NONEXISTENT_VERSION`); `EMPTY_ACCESS_TOKEN` / `INVALID_ACCESS_TOKEN`; `ACCESS_DENIED` for a missing scope or page role; 404 `NOT_FOUND` for a route or method the twin does not serve; 405 under `--read-only`. A feature of a served route the twin does not model (a poll, a reshare, targeting, a person author, …) is refused by name as 422 `[twin gap] …`, never answered as a success. |
+| connector | **Perform**: a post crosses as `POST /rest/posts`; a video post first uploads its bytes through the Videos API (initialize, presigned part PUTs, finalize, a bounded wait for `AVAILABLE`); a delete crosses as `DELETE`. A post with an **image does not cross**: LinkedIn's image PUT needs the API token on the upload host, which a presigned upload does not carry (`linkedin.connector.perform_image_upload`). A perform that finalized a video and then failed keeps the vendor's video URN, so its retry posts that video without uploading it again. **Refresh**: the pages the member administers, their follower counts and their posts. Both charge the pack's rate budget, one ledger per sealed credential; the perform's wait on a processing video backs off (2 s doubling to 15 s) so it never spends the budget the post needs. A post the kernel tombstones is gone from every read. |
+| mirror | linkedin.com's company page over the twin's own API: sign in with a page member's email (an administrator, content administrator or sponsored-content poster) and the twin-issued token; relative times read the World's clock (each answer's HTTP `Date`); the header (logo, name, description, website, follower line), the Posts feed with video players, images and article cards, and a single post's page. |
+| `/_twin/*` | Twin-only control plane: seed a page (name, vanity name, website, description, follower count, a logo image it uploaded), a member, a role on a page, and an access token with its scopes. |
+
+`src/linkedin-capabilities.ts` is the denominator: **122 capabilities, 76 done**. What is not
+modelled is enumerated there as a todo — comments, reactions and social metadata, documents, polls,
+multi-image, reshares, targeting and dark posts, post updates, member posting, captions, the media
+library, the statistics APIs, and the composer on the mirror — not omitted.
+
+The rate budget (`src/linkedin-budget.ts`): LinkedIn publishes no figures ("Standard rate limits are
+not published in documentation"), so the declaration stays at or under the kernel fallback.