@orieljs/pipeline 0.1.0-alpha.6 → 0.1.0-alpha.8

package/NOTICE

@@ -10,3 +10,7 @@ The Oriel name and logo are not covered by that license; see TRADEMARKS.md
 
 @orieljs/support (and @orieljs/framework, which bundles it) includes transliteration data from
 voku/portable-ascii (https://github.com/voku/portable-ascii), Copyright (C) 2019 Lars Moelleken, MIT License.
+
+@orieljs/notifications (and @orieljs/framework, which bundles it) includes the HTML and CSS of
+Laravel's default notification mail (laravel/framework, https://github.com/laravel/framework),
+Copyright (c) Taylor Otwell, MIT License.

package/README.md

@@ -0,0 +1,36 @@
+# @orieljs/pipeline
+
+Pipelines for Oriel: send a value through a list of steps, each of which can change it or stop it, as Laravel's `Pipeline`. The HTTP kernel runs middleware this way. It is part of `@orieljs/framework`, which every Oriel app already installs, and is re-exported from it. In an app, import it from `@orieljs/framework`; `@orieljs/pipeline` is also published on its own.
+
+```bash
+npm install @orieljs/framework
+```
+
+```ts title="app/Support/slug.ts"
+import { app } from '@orieljs/framework'
+import { PipelineFactory } from '@orieljs/framework/contracts'
+
+export function slug(title: string): Promise<string> {
+  return app(PipelineFactory)
+    .make<string>()
+    .send(title)
+    .through([
+      (value, next) => next(value.trim()),
+      (value, next) => next(value.toLowerCase()),
+      (value, next) => next(value.replace(/\s+/g, '-')),
+    ])
+    .thenReturn()
+}
+```
+
+A pipeline takes its value with `send()` and its steps with `through()` or `pipe()`: closures, or classes built by the container, whose `handle(value, next)` is called (`via()` names another method). `then(destination)` runs it and passes the result to the destination, and `thenReturn()` returns the result; both return a promise.
+
+Documentation: https://orieljs.vercel.app/docs/helpers
+
+Status: early alpha. APIs will change.
+
+## License
+
+Oriel is open-source software licensed under the Apache License 2.0 (Apache-2.0; see `LICENSE` and `NOTICE`). The Oriel name and logo are trademarks; see `TRADEMARKS.md`.
+
+Website: https://orieljs.vercel.app

package/TRADEMARKS.md

@@ -0,0 +1,33 @@
+# Oriel trademark policy
+
+The Oriel code is open source under the Apache License 2.0. The **Oriel name and logo** are not: the license covers
+the code only (section 6 of the license says so), and the name and logo stay with the project. This page explains
+what you can and can't do with them. The goal is simple: people should always be able to tell what is the real Oriel
+and what isn't.
+
+## You can, without asking
+
+- Use, change, ship and sell the code, as the license allows.
+- Say that your app or package is "built with Oriel", "for Oriel" or "compatible with Oriel".
+- Name a package `oriel-<something>` or `<something>-for-oriel` when it works with Oriel, as long as it is clear that
+  it is not official (for example, don't publish it under the `@orieljs` npm scope).
+- Use the name and logo to write about Oriel, teach it, or link to it, in articles, talks, videos and courses.
+- Use the unmodified logo to point to the project, as it is (no recolouring, cropping or
+  distortion).
+
+## You can't, without written permission
+
+- Call a fork, a modified copy or a competing product "Oriel", or anything likely to be confused with it.
+- Use the name or logo as the name, logo or domain of your own product, company or service.
+- Suggest that the Oriel project made, endorses or supports your work when it doesn't.
+- Sell merchandise with the name or logo.
+
+## Forks
+
+Forks are welcome. Please give yours a different name and logo, keep the `LICENSE` and `NOTICE` files, and say that
+it is based on Oriel.
+
+## Questions
+
+Open an issue at https://github.com/orieljs/framework or email meeeet.dev@gmail.com. If you're unsure whether a use
+is fine, ask; the answer is usually yes.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orieljs/pipeline",
-  "version": "0.1.0-alpha.6",
+  "version": "0.1.0-alpha.8",
   "description": "The Oriel Pipeline component.",
   "type": "module",
   "license": "Apache-2.0",
@@ -27,11 +27,12 @@
   "files": [
     "dist",
     "LICENSE",
-    "NOTICE"
+    "NOTICE",
+    "TRADEMARKS.md"
   ],
   "dependencies": {
-    "@orieljs/contracts": "0.1.0-alpha.6",
-    "@orieljs/container": "0.1.0-alpha.6"
+    "@orieljs/contracts": "0.1.0-alpha.8",
+    "@orieljs/container": "0.1.0-alpha.8"
   },
   "scripts": {
     "build": "tsup && node ../../../scripts/copy-license.mjs"