origami-loaders 0.0.0-stage → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+## 0.1.0
+
+The first release. `<origami-loader>` is a loader that folds a sheet of paper into an origami model, drawn in 3D as live SVG. It is one web component with no dependencies, and works in plain HTML, React, Vue, Svelte or any other framework.
+
+```sh
+npm i origami-loaders
+```
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/origami-loaders"></script>
+<origami-loader model="crane" look="paper"></origami-loader>
+```
+
+### Ten models
+
+- `crane`: all 14 steps of the classic diagram, then it flies off.
+- `plane`: the classic dart in 7 steps. It circles once, then flies off.
+- `pleat`: an accordion that breathes, for waits with no end in sight.
+- `envelope`: four corners to the centre, so a quarter of the work is one corner.
+- `boat`: a sailboat in three folds. It rocks, then sails off.
+- `frog`: the traditional jumping frog. It hops twice, then hops away.
+- `swan`: kite, neck, head. It drifts, then glides off.
+- `heart`: the classic heart. It beats.
+- `whale`: the traditional whale, from a fish base. It swims, flicks its tail and dives.
+- `fox`: a fox's face. It tilts its head and twitches its ears.
+
+### Four looks
+
+`ink` line art, `blueprint` wireframe with fold lines, `graphite` shading and two-tone `paper` with a grain that folds with the sheet. Each one works in light and dark, and can be recoloured with CSS custom properties.
+
+### Real progress
+
+Set `progress` from 0 to 1 and the paper shows that point of the fold. Call `complete()` when the work is done: the model plays its ending, then fires `ol-complete`. `seek()`, `currentStep` and the `ol-step` event let a page follow the fold step by step.
+
+### Built in
+
+- Reduced motion is respected, and loaders pause when they scroll off screen.
+- Safe to import during server rendering (Next.js, Nuxt, SvelteKit, Astro).
+- About 21 kB gzipped with all ten models. The Paper Shaders grain loads on demand as its own chunk.
+- The folding engine is exported (`Folder`, `registerModel`), so a page can fold and register its own models.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 rishiashar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,205 @@
-# Temporary Holding Version
+# origami-loaders
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Loaders that fold.** 3D origami animations rendered as lightweight SVG — no canvas, no WebGL, no dependencies.
+
+A framework-agnostic web component: drop `<origami-loader>` into any page, React, Vue, Svelte or plain HTML.
+
+## Install
+
+```sh
+npm i origami-loaders
+```
+
+With a bundler, import the package once. It registers the `<origami-loader>` element as a side effect. The `OrigamiLoader` class is also exported. It is safe to import during server rendering (Next.js, Nuxt, SvelteKit, Astro): the element registers only once the page runs in a browser.
+
+```js
+import 'origami-loaders';
+```
+
+```html
+<origami-loader look="ink"></origami-loader>
+```
+
+Without a bundler, load the IIFE build from jsDelivr:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/origami-loaders"></script>
+<origami-loader look="blueprint" theme="dark"></origami-loader>
+```
+
+## Attributes
+
+| Attribute  | Values                                   | Default | Description |
+| ---------- | ---------------------------------------- | ------- | ----------- |
+| `model`    | `crane`, `plane`, `pleat`, `envelope`, `boat`, `frog`, `swan`, `heart`, `whale`, `fox` | `crane` | Which origami model to fold. |
+| `look`     | `ink` \| `blueprint` \| `graphite` \| `paper` | `ink`   | Rendering style. |
+| `theme`    | `light` \| `dark` \| `auto`              | `auto`  | `auto` follows `prefers-color-scheme`. |
+| `speed`    | number                                   | `1`     | Playback speed multiplier. |
+| `progress` | `0`..`1`                                 | unset   | When present, the loader is in determinate mode and shows that point of the fold sequence instead of playing. |
+| `paused`   | boolean attribute                        | unset   | Pauses playback. |
+
+## CSS custom properties
+
+| Property      | Used by           | Description |
+| ------------- | ----------------- | ----------- |
+| `--ol-ink`    | all looks         | Line color. |
+| `--ol-bg`     | all looks         | Face fill used to hide lines behind other faces. Should match the page background. |
+| `--ol-front`  | `paper`           | Front-side paper color. |
+| `--ol-back`   | `paper`           | Back-side paper color. |
+| `--ol-stroke` | all looks         | Line width, e.g. `1.5px`. |
+
+Size is set with CSS `width` / `height` (default `160px` square).
+
+```css
+origami-loader {
+  width: 96px;
+  height: 96px;
+  --ol-ink: #1b1b1d;
+  --ol-bg: #fff;
+  --ol-stroke: 1.5px;
+}
+```
+
+## JavaScript API
+
+```js
+const el = document.querySelector('origami-loader');
+
+el.duration;      // total length of the fold sequence, in seconds
+el.seek(2.5);     // jump to a time, in seconds
+el.currentStep;   // { index, diagram, label }
+el.stepCount;     // steps on the paper diagram: 14 for the crane, 7 for the plane
+
+el.addEventListener('ol-step', (e) => {
+  const { index, diagram, label } = e.detail; // fired when the step changes
+});
+```
+
+### Real progress
+
+Set `progress` as work advances, then call `complete()` when it is done. The model plays its ending (the crane flies off, the plane leaves), fires `ol-complete`, and stays empty until you start again.
+
+```js
+upload.on('progress', (p) => el.setAttribute('progress', p)); // 0 to 1
+upload.on('done', () => el.complete());
+el.addEventListener('ol-complete', () => showSent());
+el.restart(); // or set progress again to fold a fresh sheet
+```
+
+## Models
+
+| Model | What it does |
+| --- | --- |
+| `crane` | The default. All 14 steps of the classic diagram, about 25 seconds a loop, then it flies off. |
+| `plane` | The classic dart in 7 steps. Circles once, then flies off. |
+| `pleat` | An accordion that breathes. Made for "thinking" and other waits with no end in sight. |
+| `envelope` | Four corners to the centre, so progress maps neatly: a quarter of the work, one corner. |
+| `boat` | A sailboat in three folds. Rocks on the water, then sails off. |
+| `frog` | The traditional jumping frog, from a waterbomb base. Its pleat is a spring: it hops twice, then hops away. |
+| `swan` | Kite, neck, head. Drifts on the water, then glides off. |
+| `heart` | The classic heart, folded on the side you see. It beats. |
+| `whale` | The traditional whale, from a fish base: the rabbit ears become its flippers. Swims, flicks its tail, then dives. |
+| `fox` | A fox's face. Tilts its head and twitches its ears. |
+
+Pick one with the `model` attribute:
+
+```html
+<origami-loader model="plane"></origami-loader>
+```
+
+## Looks
+
+- **ink** — line art, hidden lines removed.
+- **blueprint** — see-through wireframe with diagram-style fold lines.
+- **graphite** — monochrome with soft light shading.
+- **paper** — two-tone origami paper.
+
+## Status
+
+The paper crane folds through all 14 steps of the classic diagram, about 25 seconds per loop: pre-creases, square base, petal folds on both sides, narrowing, inside reverse folds for the neck, tail and head, then the wings spread and it flies off while a new sheet drops in.
+
+- [x] Folding engine: folds against the paper as it lies, solved compound folds, layer stacking, 3D projection, depth sorting
+- [x] The crane, all 14 steps
+- [x] Four looks, light and dark, recolourable, with procedural paper grain
+- [x] Progress mode, reduced motion, pauses off screen
+- [x] A second model, the paper plane
+- [x] Ten models: crane, plane, pleat, envelope, boat, frog, swan, heart, whale, fox
+- [x] A fold check in the test suite that catches the wrong layer showing, folds that undo themselves, and torn creases
+- [ ] Static SVG export for no-JS / `<img>` use
+- [x] Paper look: models can start coloured side down, as real ones do, so the plane and envelope fold the colour out
+- [x] Reverse folds are real: the point is mirrored across its crease and stays joined to it (the crane's neck, tail and head, the swan's neck and head, the whale's tail)
+- [x] The crane shows only its coloured side, wings included, as a crane folded from one-sided paper does
+
+## How it works
+
+A model is written the way origami is taught: one fold at a time, against the paper as it currently lies (`src/models/crane.ts`).
+
+1. **Folds cut the paper.** Each fold splits the faces it passes through along the fold line, so the crease pattern builds itself (`src/fold.ts`).
+2. **Joints move the faces.** A hinge rotates faces about a fold line; joints chain, so a flap can fold while it is being lifted. A **reverse fold** mirrors the point across its crease, so it turns inside out and stays joined along the crease, tucked between the layers (inside) or wrapped round them (outside). It gets there the way fingers move it: it swings round and turns over about its own spine, opening like a book.
+3. **Compound folds are solved.** The square base and the petal folds move several creases at once. Those angles are left free, `pin` says which corners must stay together, and a small Gauss–Newton solver works out the angles along the whole motion so the paper never tears. The frog's waterbomb base is worked out exactly instead: as each side triangle turns in by θ, the top comes down by γ = 2·atan(tan(θ/2)/√2).
+4. **Layers are tracked.** After every step the engine works out which face ended up on top wherever two overlap, and gives every face a layer height, so flat stacks have real thickness. Paper that stands up, like a crane's spread wings, keeps its stacking turned with it.
+5. **Rendering.** Faces are projected with a perspective camera and shaded by how they face a light. Faces lying flat together are drawn as one panel and painted back-to-front with plane tests and a topological sort; where no plane separates two panels, the one nearer the eye where they actually overlap goes on top (`src/scene.ts`).
+6. **Paper.** Paper Shaders' paper-texture shader renders the grain once per page on a hidden WebGL canvas; the result is baked into an image that each panel maps in sheet space, so the grain folds with the paper (`src/paper-shader.ts`, with a small CPU fallback in `src/texture.ts`).
+7. **Looks are CSS** (`src/styles.ts`). The paper look colours the front of the sheet; a model compiled with `colourDown` starts with the front facing away, the way you fold coloured paper, so the folds bring the colour out.
+
+The crane compiles in about 50 ms on first use. A frame costs about 1 ms of script. The whole package, all ten models included, is about 21 kB gzipped.
+
+## Development
+
+`npm test` also runs a fold check over every model (`test/inspect.ts`, under a second). At several moments in every step it lays the frame out exactly as the renderer does and fails if a farther layer is painted over a nearer one (the wrong side of the paper showing), if a face rides folds that undo each other, or if a crease tears. A reverse fold may open its crease on the way, but it must be shut again by the end of the step.
+
+```sh
+npm install
+npm run typecheck
+npm test
+npm run build      # dist/ bundles + types, and a self-contained demo/dist/index.html
+npm run demo       # build, then print the demo page path
+npm run capture    # screenshots + video of the demo (needs Playwright and ffmpeg)
+```
+
+## Releasing
+
+Publishing runs in GitHub Actions when a `v*` tag is pushed (`.github/workflows/publish.yml`). It typechecks, tests, builds, checks the tag against the version in `package.json`, then publishes with provenance: a signed record on npm of the commit and workflow that built the package. What changed in each version is in `CHANGELOG.md`.
+
+### The first release, with a token
+
+The package does not exist on npm until the first release, so that one release uses a token.
+
+1. On npmjs.com, go to Access Tokens and generate a granular access token:
+   - **Bypass two-factor authentication** ticked, so the workflow can publish without a code from your phone.
+   - Packages and scopes: **Read and write (publish and stage)** on **All Packages**. The package cannot be picked by name until it exists.
+   - Expiration: 7 days. It is only needed once.
+2. In the GitHub repo, go to Settings, Secrets and variables, Actions, and add the token as a repository secret named `NPM_TOKEN`.
+3. Tag the release commit on `main` and push the tag:
+
+   ```sh
+   git tag v0.1.0
+   git push origin v0.1.0
+   ```
+
+4. Follow the Publish run in the repo's Actions tab. When it is green, the package is at npmjs.com/package/origami-loaders.
+5. Delete the `NPM_TOKEN` secret and revoke the token on npmjs.com. It has done its job.
+
+### Every release after, with no token
+
+From then on, npm trusts this repo's publish workflow directly (trusted publishing), so no token is stored anywhere. npm stops letting tokens publish directly in January 2027, so this is the way to release from then on. The workflow needs no change: npm tries trusted publishing first and falls back to a token only when there is one.
+
+1. On npmjs.com, open the package's Settings, find Trusted Publisher, choose GitHub Actions and enter `rishiashar`, `origami-loaders` and `publish.yml`. The next publish must happen within 2 days of adding it, or the connection expires and has to be added again, so do this when the next release is ready.
+2. Bump the version, tag it and push:
+
+   ```sh
+   npm version 0.1.1 --no-git-tag-version   # or edit package.json by hand
+   git commit -am "Release v0.1.1"
+   git tag v0.1.1
+   git push && git push --tags
+   ```
+
+3. Once that release is out, go to the package's Settings, Publishing access, and choose **Require two-factor authentication and disallow tokens**, so a leaked token can never publish.
+
+## Credits
+
+The paper texture comes from the paper-texture shader in [Paper Shaders](https://shaders.paper.design) (Apache-2.0), rendered once per page and baked into the grain that folds with the paper. It loads on demand as its own chunk; `texture="grain"` uses a smaller built-in grain instead, and `texture="none"` turns texture off. See `THIRD_PARTY_NOTICES.txt`.
+
+## License
+
+MIT

package/THIRD_PARTY_NOTICES.txt

@@ -0,0 +1,215 @@
+origami-loaders bundles third-party code:
+
+================================================================
+Paper Shaders (@paper-design/shaders 0.0.82), used for the paper texture
+https://shaders.paper.design — https://github.com/paper-design/shaders
+License: Apache-2.0
+
+Paper Shaders
+Copyright 2026 Paper
+
+Powered by Paper Shaders:
+https://shaders.paper.design
+
+----------------------------------------------------------------
+                                 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/dist/chunks/chunk-IHRIUEAN.js

@@ -0,0 +1 @@
+var d=Object.defineProperty;var e=(b,a,c)=>a in b?d(b,a,{enumerable:!0,configurable:!0,writable:!0,value:c}):b[a]=c;var f=(b,a,c)=>e(b,typeof a!="symbol"?a+"":a,c);export{f as a};