@osdlc/tiered-dirs 0.0.0-stage → 0.3.0

package/CHANGELOG.md

@@ -0,0 +1,99 @@
+# Changelog
+
+## 0.3.0
+
+### Minor Changes
+
+- 93ca515: First public release. Machine-local directories for one vendor's products, addressed on two axes:
+  the tier says who shares the state (the vendor, a suite of products, or one standalone tool), and
+  the home says how durable it is (durable, config, cache, state, logs, runtime). The homes come
+  from a per-OS table with native or XDG paths, every root can be moved by an override variable,
+  and a test runner process gets a scratch root instead of the real home unless `<P>_ROOT` is set
+  or `HOME` was moved off the passwd home (see the README for the rules).
+  
+  The additions:
+  
+  - `TieredDirs`, with `vendor()`, `suite(key)` and `standalone(tool)`, which return a `Tier`. A
+    `Tier` gives a `Dir` for each home: `durable()`, `config()`, `cache()`, `state()`, `logs()`,
+    `runtime()`, or `home(name)`. `Dir.scoped(kind, key)` and `Dir.app(app)` narrow a directory.
+    `TieredDirs.scratch()` gives the platform temp directory, outside both axes.
+  - `TieredDirs.fromEnv(vendor, vars, opts)` and `systemBaseDirs(vars, opts)` resolve the base
+    directories from the environment once. `rootedBaseDirs(root)` lays every root out under one
+    directory, and `xdgBaseDirs(home, env)` builds the XDG table under any home.
+  - `envVars(prefix)` names the override variables: `<P>_ROOT`, `<P>_<HOME>_DIR`,
+    `<P>_SCRATCH_DIR`, `<P>_REQUIRE_OVERRIDE` and `<P>_CONVENTION`. `overrideVars(vars)` lists the
+    ones that move a directory. `isOverridden(vars, env)` says whether any of them is set to a
+    non-empty value.
+  - Conventions: `native` (the default) or `xdg`, chosen by the caller or by `<P>_CONVENTION`.
+    `parseConvention(value)` parses one exactly, untrimmed.
+  - `isValidSegment(key)`, the rule every caller-supplied segment must pass. `state`, `logs` and
+    `run` are reserved.
+  - `isVendorBundleId(vendor, bundleId)`, the check `TieredDirs.isVendorBundleId` makes, for a
+    caller with no `TieredDirs`.
+  - `TieredDirsError`, the one error class the package throws. Its `code` is one of
+    `MISSING_BASE_DIR`, `RELATIVE_OVERRIDE`, `OVERRIDE_REQUIRED`, `INVALID_CONVENTION` and
+    `INVALID_KEY`.
+  - `ResolveOptions`, the options of `systemBaseDirs` and `TieredDirs.fromEnv`. `testRoot: false`
+    skips the test-root default; `<P>_ROOT` and `<P>_REQUIRE_OVERRIDE` still apply.
+  - `testRoot()`, the per-process scratch root in a test runner process, else `undefined`.
+  - The types `BaseDirs`, `EnvVars`, `Home`, `Convention`, `TierKind`, `ResolveOptions` and
+    `TieredDirsErrorCode`, and the lists `HOMES`, `CONVENTIONS` and `TIER_KINDS`. A minor release
+    may add a member to `TierKind`, `Convention` or `TieredDirsErrorCode`, or a name to `EnvVars`.
+  - The test-root rule recognises a Vitest worker (`VITEST_WORKER_ID` or `VITEST_POOL_ID` set, and
+    the entry point in the `vitest` package's `dist/workers` folder, or tinypool's
+    `dist/entry/process.js` or `dist/entry/worker.js` on Vitest 3 and earlier), as well as `NODE_ENV=test`,
+    `node --test` and Bun. A child process a test spawns still gets no default.
+  
+  Changes:
+  
+  - `Dir` and `Tier` are exported as types only. A caller gets a value from the checked methods
+    (`TieredDirs.vendor()`, `suite()`, `standalone()`, `scratch()`, `Tier.home()` and `Dir.scoped()`
+    or `app()`), never from a constructor.
+  - Every `BaseDirs` field is `readonly`.
+  - Aligned with the Rust crate tiered-dirs 0.3.0.
+
+## History before the first public release
+
+These versions were never published. They are rebuilt from the git history.
+
+### [0.2.0] - 2026-10-17 (unpublished)
+
+#### Added
+
+- A `state` home: `state` in `Home` and `HOMES`, `Tier.state()`, `<P>_STATE_DIR` and
+  `<root>/state`. It is the XDG state home on Linux and Application Support on macOS. On Windows
+  it is `%LOCALAPPDATA%\state`, beside each tier's cache folder, never the same folder.
+- Conventions: `native` (the default) or `xdg`, through `systemBaseDirs(vars, { convention })`
+  and `TieredDirs.fromEnv(vendor, vars, { convention })`, with `Convention` and `CONVENTIONS`.
+  `xdg` gives the XDG paths on macOS too; Linux is the same under both, and on Windows `xdg`
+  means `native`. A relative `XDG_*` value is ignored and `~` is not expanded.
+- `xdgBaseDirs(home, env)` builds the XDG table under any home.
+- `<P>_CONVENTION=native|xdg` overrides the caller's convention; any other value throws
+  `TieredDirsError`.
+
+#### Changed
+
+- Breaking: `Home` and `HOMES` gain `state`. An exhaustive `switch` over `Home` must handle it.
+- Breaking: `EnvVars` has `state` and `convention` names, and `BaseDirs` has a `state` root. An
+  object built by hand needs them; build `EnvVars` with `envVars()`.
+- Breaking: `state`, `logs` and `run` are reserved segment names, refused in any case, so no tier
+  lands on another home's root. `suite`, `standalone`, `Dir.scoped`, `Dir.app` and
+  `isValidSegment` refuse them.
+
+### [0.1.0] - 2026-10-06 (unpublished)
+
+#### Added
+
+- `TieredDirs`, `Tier` and `Dir`: directories addressed by tier (`vendor()`, `suite(key)`,
+  `standalone(tool)`) and home (`durable`, `config`, `cache`, `logs`, `runtime`), plus an
+  untiered `scratch()` root. Every builder returns a new value, and every caller-supplied segment
+  is checked to be one safe path segment.
+- `systemBaseDirs` and `TieredDirs.fromEnv`: the per-OS table resolved once, with logs in
+  `~/Library/Logs` on macOS and runtime under the durable home where the platform has none. Every
+  input is injectable: the platform, the environment, the home directory and single roots.
+- Override variables under a caller-chosen prefix (`envVars`, `overrideVars`), and
+  `rootedBaseDirs` for the layout `<P>_ROOT` selects.
+- Test isolation: in a test runner process with `<P>_ROOT` unset, the root reads as a scratch
+  directory unique to the process, and `<P>_REQUIRE_OVERRIDE` turns a fallback to the real home
+  into an error.
+- `TieredDirsError`, `isValidSegment`, `HOMES` and `TIER_KINDS`.

package/CONTRIBUTING.md

@@ -0,0 +1,66 @@
+# Contributing
+
+Thanks for your interest in `@osdlc/tiered-dirs`.
+
+## Issues
+
+Report bugs and ask for features in the
+[issue tracker](https://github.com/osdlc/osdlc/issues). For a bug, include the
+library version, your runtime and its version, your operating system, and the
+call and inputs that misbehave. Report security problems privately. See
+[SECURITY.md](./SECURITY.md).
+
+## Pull requests
+
+This package lives in [osdlc/osdlc](https://github.com/osdlc/osdlc) under
+`packages/ts/tiered-dirs`. Open pull requests there. They are reviewed and merged
+there.
+
+## Running the tests
+
+The repository is a pnpm workspace. Install from the repository root, then
+work in the package directory. The tests run on [Vitest](https://vitest.dev)
+under Node 22.12 or later.
+
+```sh
+pnpm install
+cd packages/ts/tiered-dirs
+pnpm test
+```
+
+`pnpm run coverage` reports test coverage.
+
+`pnpm run build` compiles the package to `dist/`. `pnpm run smoke` runs
+`tests/smoke.mjs`, a short check of the built package under Node. Build first.
+It is not published.
+
+Other checks:
+
+```sh
+pnpm run typecheck
+pnpm run lint
+pnpm run format:check
+```
+
+## The parity fixture
+
+`packages/rust/tiered-dirs/tests/fixtures/parity.json` is read by this
+package's `tests/parity.test.ts` and by the Rust crate's `tests/parity.rs`.
+A new path shape goes into that file first, so both suites cover it. Neither
+twin may add a shape the other lacks.
+
+## Code style
+
+- TypeScript, ES modules, and explicit `.ts` import paths.
+- Prettier formats the code and oxlint checks it. Run `pnpm run format` and
+  `pnpm run lint` before you commit.
+- Add a test for each behaviour change or bug fix.
+- A new export gets TSDoc and a use in `examples/`, which imports the package
+  by name. A test fails if an export has no example.
+- An export's TSDoc says "Stable in 0.x." and the README's Stability section
+  lists it. A test checks both.
+- Path assertions must not depend on the separator: compare with `normalize`.
+- For a change users can see, add a changeset: run `pnpm changeset` at the
+  repository root. Start a breaking change's summary with `**Breaking:**`.
+  Do not edit `CHANGELOG.md` or `version` by hand; the release writes them.
+  See [packages/README.md](https://github.com/osdlc/osdlc/blob/main/packages/README.md).

package/LICENSE-APACHE

@@ -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 2026 Sizer LLC
+
+   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/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sksizer
+
+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.