@cldmv/slothlet 1.0.0

package/LICENSE

@@ -0,0 +1,210 @@
+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 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,115 @@
+# @cldmv/slothlet
+
+[![npm version](https://img.shields.io/npm/v/@cldmv/slothlet.svg)](https://www.npmjs.com/package/@cldmv/slothlet)
+[![license](https://img.shields.io/github/license/CLDMV/slothlet.svg)](LICENSE)
+![size](https://img.shields.io/npm/unpacked-size/@cldmv/slothlet.svg)
+![npm-downloads](https://img.shields.io/npm/dm/@cldmv/slothlet.svg)
+![github-downloads](https://img.shields.io/github/downloads/CLDMV/slothlet/total)
+
+> **⚠️ WARNING: This module is under active development!**
+>
+> - The standard **eager mode** works well and is stable for production use.
+> - **Lazy mode** has been tested and works for most use cases.
+> - **Experimental modes** (such as worker, child process, and advanced context binding) are in development and may not be fully functional or stable.
+>
+> Please report issues, contribute, and use experimental features with caution.
+
+**@cldmv/slothlet** is a modern, lazy modular API loader for Node.js projects. Designed for developers who want fast, flexible, and memory-efficient access to large modular APIs, it dynamically loads API modules and submodules only when accessed. Slothlet supports both lazy and eager loading, automatic flattening of single-file modules, and descriptive error handling—all with a fun branding twist: "slothlet is anything but slow."
+
+## Features
+
+- **Lazy loading:** API endpoints are loaded on demand using ES6 Proxy, minimizing initial load time and memory usage.
+- **Eager loading:** Optionally load all modules up front for maximum performance.
+- **Automatic flattening:** Single-file modules (e.g., `math/math.mjs`) become `api.math`.
+- **CamelCase mapping:** Filenames and folders with dashes are mapped to camelCase API properties (e.g., `root-math.mjs` → `api.rootMath`).
+- **Descriptive errors:** Throws clear errors for missing API paths or methods.
+- **Configurable:** Set root directory and lazy loading depth.
+- **ESM-first:** Clean, standards-based API.
+- **TypeScript-friendly:** JSDoc-annotated API for editor support.
+- **Lightweight:** No dependencies, minimal footprint.
+
+## Installation
+
+```sh
+npm install @cldmv/slothlet
+```
+
+## Usage
+
+> **Note:**
+>
+> - When using **lazy mode**, all API calls must be `await`ed, as modules are loaded asynchronously on access.
+> - If you need to create more than one slothlet instance, you must import the slothlet module using a param string (e.g., `import slothlet from "./slothlet.mjs?instance=1"`).
+>   - **Caveat:** Live bindings (`self`, `context`, `reference`) will only work correctly if you use the same param string for both the loader and any submodules that import those bindings. Mismatched param strings will result in separate module instances and broken live bindings.
+
+### Node.js API
+
+```js
+import slothlet from "@cldmv/slothlet";
+
+// Lazy load from default directory
+const api = await slothlet.create({ lazy: true, context });
+
+// Access API endpoints
+const sum = await api.math.add(2, 3); // 5
+const upper = await api.string.upper("abc"); // 'ABC'
+const today = await api.nested.date.today(); // '2025-08-15'
+
+
+
+// Eager load from a custom directory
+const api = await slothlet.create({ lazy: false, dir: "./api_test" context });
+
+// Access API endpoints
+const sum = api.math.add(2, 3); // 5
+const upper = api.string.upper("abc"); // 'ABC'
+const today = api.nested.date.today(); // '2025-08-15'
+```
+
+## API Reference
+
+### Main Methods
+
+- `slothlet.create(options)` — Loads API modules and returns a bound API object. Options include lazy/eager mode, context, reference, and directory.
+- `slothlet.load(config, ctxRef)` — Loads API modules (lazy or eager) and binds context/reference. Returns the API object.
+- `slothlet.createBoundApi(context, reference)` — Returns an API object bound to the provided context and reference.
+- `slothlet.getApi()` — Returns the loaded API object (Proxy or plain object).
+- `slothlet.getBoundApi()` — Returns the bound API object (with context/reference).
+- `slothlet.isLoaded()` — Returns true if the API is loaded.
+- `slothlet.shutdown()` — Gracefully shuts down the API and internal resources.
+
+### Config Options
+
+- `lazy` (boolean): Enable lazy loading (default: true)
+- `lazyDepth` (number): How deep to lazy load subdirectories (default: Infinity)
+- `dir` (string): Directory to load API modules from (default: loader's directory)
+- `debug` (boolean): Enable debug logging (default: false)
+
+### Context & Reference
+
+- `context`: Object passed to API modules for contextual data (e.g., user/session info)
+- `reference`: Object passed to API modules for additional references or configuration
+
+### Error Handling
+
+- Throws descriptive errors for missing API paths or methods
+- All errors include the requested path and directory for easier debugging
+
+### JSDoc
+
+See JSDoc comments in the source code for detailed type annotations and usage examples.
+
+## Module Structure
+
+- Single-file modules: `api_test/math/math.mjs` → `api.math`
+- Multi-file modules: `api_test/multi/alpha.mjs` → `api.multi.alpha`, `api_test/multi/beta.mjs` → `api.multi.beta`
+- Dashes in names: `api_test/root-math.mjs` → `api.rootMath`
+
+## Safety & Errors
+
+- Throws descriptive errors for missing API paths or methods
+- Only loads modules when accessed (lazy) or all at once (eager)
+
+## License
+
+Apache-2.0 © Shinrai / CLDMV

package/package.json

@@ -0,0 +1,56 @@
+{
+	"name": "@cldmv/slothlet",
+	"version": "1.0.0",
+	"description": "Slothlet: Lazy Modular API Loader for Node.js. Dynamically loads API modules and submodules only when accessed, supporting both lazy and eager loading.",
+	"main": "slothlet.mjs",
+	"exports": {
+		".": "./slothlet.mjs"
+	},
+	"directories": {
+		"test": "tests"
+	},
+	"scripts": {
+		"test": "vitest run",
+		"testjest": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js"
+	},
+	"keywords": [
+		"api",
+		"lazy-loading",
+		"modular",
+		"nodejs",
+		"esm"
+	],
+	"author": {
+		"name": "Shinrai",
+		"email": "git@cldmv.net",
+		"url": "https://cldmv.net"
+	},
+	"contributors": [
+		{
+			"name": "CLDMV",
+			"url": "https://github.com/CLDMV"
+		}
+	],
+	"license": "Apache-2.0",
+	"type": "module",
+	"devDependencies": {
+		"jest": "^30.0.5",
+		"vest": "^5.4.6",
+		"vitest": "^3.2.4"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/CLDMV/slothlet.git"
+	},
+	"bugs": {
+		"url": "https://github.com/CLDMV/slothlet/issues"
+	},
+	"homepage": "https://github.com/CLDMV/slothlet#readme",
+	"publishConfig": {
+		"access": "public"
+	},
+	"files": [
+		"README.md",
+		"LICENSE"
+	]
+}