@rulecad/frames 0.0.0-stage → 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 JoniBach and contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,40 @@
1
- # Temporary Holding Version
1
+ # @rulecad/frames
2
2
 
3
- 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.
3
+ Structures built from beams. A beam is a length of a profile: an aluminium extrusion from any maker's spec sheet, a
4
+ plain tube or angle, or a beam printed in plastic. Part of [rulecad](https://github.com/JoniBach/rulecad), a kit for
5
+ designing physical things where every measurement says which rule it comes from.
6
+
7
+ **This is a first release that holds the name.** It installs and loads, and it has no functions to call yet. They
8
+ arrive with 0.1.0. Until then there is no reason to install it.
9
+
10
+ ```js
11
+ import { status } from '@rulecad/frames'
12
+ status.release // 'placeholder' now, 'ready' from 0.1.0
13
+ ```
14
+
15
+ ## What it will do
16
+
17
+ - **Profiles as rule sets.** T-slot in metric and inch series, V-slot, the small 10 and 15 mm beams, tube, angle
18
+ and channel, each from its maker's sheet with its sources, plus any section of your own.
19
+ - **Beams.** A profile and a length, with an address for any point along any face, so things attach by saying
20
+ where.
21
+ - **Joins that do their own drilling.** Say how two beams are joined (a blind joint, a bracket, a gusset) and the
22
+ tapped ends, access holes, fittings and screws follow.
23
+ - **Fittings drawn from the profile's rules.** Brackets, feet, panel clips, mounts and slot-nut carriers that print
24
+ without supports, with bought ones as an alternative.
25
+ - **Guides.** Linear rails, V-wheels, rods and printed sliders on a beam, each an ordinary sliding joint.
26
+ - **Printed beams**, with profiles that print lying down and still take a standard slot nut.
27
+
28
+ In `@rulecad/cad` a frame gets a cut list, a cut-and-drill sheet per beam, a build order, and checks as a structure:
29
+ how far it sags, where it is stressed, how it sways, and what it resonates at.
30
+
31
+ It is called frames because "extrusion" also means filament leaving a nozzle.
32
+
33
+ ## Where the work is
34
+
35
+ The plan and its tickets are in [issue 240](https://github.com/JoniBach/rulecad/issues/240). The specification is
36
+ `docs/fixings-and-frames.md` in the repository.
37
+
38
+ ## Licence
39
+
40
+ MIT.
package/frames.d.mts ADDED
@@ -0,0 +1,9 @@
1
+ /**
2
+ * What this release is. `release` is `'placeholder'` until the package has functions to call (0.1.0), then `'ready'`:
3
+ * code that wants frames can test it instead of failing on a missing export.
4
+ * @type {Readonly<{ release: 'placeholder' | 'ready', plan: string }>}
5
+ */
6
+ export const status: Readonly<{
7
+ release: "placeholder" | "ready";
8
+ plan: string;
9
+ }>;
package/frames.mjs ADDED
@@ -0,0 +1,10 @@
1
+ // @rulecad/frames: structures from beams, of any profile, with the fittings and guides that attach to them.
2
+ // This first release holds the package's name on npm so the release workflow can publish what follows; the functions
3
+ // arrive with 0.1.0. The plan is https://github.com/JoniBach/rulecad/issues/240.
4
+
5
+ /**
6
+ * What this release is. `release` is `'placeholder'` until the package has functions to call (0.1.0), then `'ready'`:
7
+ * code that wants frames can test it instead of failing on a missing export.
8
+ * @type {Readonly<{ release: 'placeholder' | 'ready', plan: string }>}
9
+ */
10
+ export const status = Object.freeze({ release: 'placeholder', plan: 'https://github.com/JoniBach/rulecad/issues/240' });
package/package.json CHANGED
@@ -1,6 +1,27 @@
1
1
  {
2
2
  "name": "@rulecad/frames",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.0.1",
4
+ "description": "Structures from beams: aluminium extrusion of any maker's profile, plain tube and angle, or printed beams, with the brackets, slot nuts, mounts and linear guides that attach to them. A first release that holds the name while the package is built: it installs and has nothing to call yet.",
5
+ "type": "module",
6
+ "exports": {
7
+ ".": {
8
+ "types": "./frames.d.mts",
9
+ "default": "./frames.mjs"
10
+ }
11
+ },
12
+ "types": "./frames.d.mts",
13
+ "files": [
14
+ "frames.mjs",
15
+ "frames.d.mts",
16
+ "README.md",
17
+ "LICENSE"
18
+ ],
19
+ "license": "MIT",
20
+ "keywords": ["aluminium-extrusion", "t-slot", "v-slot", "frames", "3d-printing", "jscad", "cad"],
21
+ "engines": { "node": ">=20.10" },
22
+ "sideEffects": false,
23
+ "repository": { "type": "git", "url": "git+https://github.com/JoniBach/rulecad.git", "directory": "packages/frames" },
24
+ "homepage": "https://github.com/JoniBach/rulecad/tree/main/packages/frames#readme",
25
+ "bugs": { "url": "https://github.com/JoniBach/rulecad/issues" },
26
+ "scripts": { "test": "node --test" }
27
+ }