@skhema/method 0.1.1 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Skhema
+
+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,36 +1,93 @@
-# `@skhema/method`
+# @skhema/method
 
-This package is the emerging public boundary for stable Skhema methodology
-definitions.
+The complete, public **Skhema method** as one installable artifact: the
+canonical vocabulary of strategic components and element types, the curated
+definitions that make each element buildable (slots, expected moods, examples,
+relationships), and a structural validator — with **zero runtime
+dependencies**. Validate your own strategy artifacts without the platform.
 
-Schema identity comes from `@skhema/types/schema`. This package should not
-redefine canonical component values, element values, labels, acronyms, or
-component-element mapping.
+## Install
 
-It should own:
+```sh
+npm i @skhema/method
+```
 
-- component and element definitions
-- expected moods
-- method slot definitions
-- required vs optional slots
-- labels, descriptions, examples
-- valid element relationships
-- extension points for future/custom method variants
+Requires Node ≥ 18. ESM only.
 
-`@skhema/intelligence` should consume these definitions for validation, prompt
-building, parsing, slot replacement, graph ingestion, and reasoning.
+## The vocabulary
 
-The current definitions are a first curated pass from:
+`@skhema/method/vocabulary` is the identity layer of the method: the 5
+strategic components, the 19 element types, and the mapping between them. It is
+the same vocabulary that renders in Skhema embeds and API payloads.
 
-- `@skhema/types/schema`
-- `data/working/sk_variable_semantic_and_verb_slots_config.json`
-- `data/working/sk_variable_element_type_examples.json`
+```ts
+import {
+  COMPONENT_TYPES,
+  ELEMENT_TYPES,
+  SKHEMA_MAPPING,
+  getElementsForComponent,
+  isValidElementValue,
+} from '@skhema/method/vocabulary'
 
-Known normalization:
+ELEMENT_TYPES.KEY_CHALLENGE
+// { value: 'key_challenge', label: 'Key Challenge', acronym: 'CHL' }
 
-- The working files use `associated_impact`; the canonical element value in
-  `@skhema/types/schema` is `impact`. The method package exposes `impact` and
-  keeps `associated_impact` as an alias.
-- The working files use `solution_alternative`; the canonical element value in
-  `@skhema/types/schema` is `solution`. The method package exposes `solution`
-  and keeps `solution_alternative` as an alias.
+getElementsForComponent(COMPONENT_TYPES.DIAGNOSIS.value).map((e) => e.value)
+// ['key_challenge', 'supporting_fact', 'impact']
+
+isValidElementValue('experiment') // true
+```
+
+### Stability: additive-only
+
+Within a major version, the vocabulary only grows. Existing component and
+element values, labels, and acronyms are never renamed or removed; new entries
+may be added in minor releases. You can persist vocabulary values in your own
+systems and trust them across upgrades.
+
+## The definitions
+
+The package root adds the definitions layer — what each element _is_ and what
+a well-formed one contains — and re-exports the vocabulary, so a full consumer
+needs one import.
+
+```ts
+import {
+  getElementDefinition,
+  getRequiredMethodSlots,
+  listElementRelationships,
+  validateMethodSpec,
+} from '@skhema/method'
+
+const challenge = getElementDefinition('key_challenge')
+challenge?.expectedMood // 'indicative'
+challenge?.examples[0] // a worked example of a well-formed key challenge
+
+getRequiredMethodSlots('key_challenge').map((slot) => slot.id)
+// the semantic slots a complete key challenge must fill
+
+// Relationships describe how elements connect across a strategy.
+listElementRelationships().find(
+  (r) => r.source === 'key_challenge' && r.target === 'solution'
+)
+
+// The spec validates itself — the same check runs in this package's CI.
+validateMethodSpec() // [] when the shipped definitions are internally consistent
+```
+
+Some historical element-type names are kept as aliases so older artifacts keep
+resolving: `associated_impact` → `impact`, `solution_alternative` → `solution`.
+`getElementDefinition` accepts either form.
+
+## Which package do I want?
+
+| Package                     | Purpose                                                                                 |
+| --------------------------- | --------------------------------------------------------------------------------------- |
+| **`@skhema/method`** (this) | The method itself — vocabulary, definitions, validation. No network, no account needed. |
+| `@skhema/sdk`               | Typed client for the Skhema Public API (`api.skhema.com/v1`).                           |
+| `@skhema/cli`               | The same API as a terminal command (`skhema`), plus agent onboarding.                   |
+| `@skhema/embed`             | Render Skhema elements on your own site.                                                |
+
+## License
+
+MIT

package/dist/definitions.d.ts

@@ -1,4 +1,4 @@
-import type { ElementDefinition, ElementRelationshipDefinition } from "./types.js";
+import type { ElementDefinition, ElementRelationshipDefinition } from './types.js';
 export declare const componentDefinitions: readonly [{
     readonly type: "diagnosis";
     readonly label: "Diagnosis";
@@ -27,4 +27,3 @@ export declare const componentDefinitions: readonly [{
 }];
 export declare const elementDefinitions: readonly [ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition, ElementDefinition];
 export declare const elementRelationshipDefinitions: readonly [ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition, ElementRelationshipDefinition];
-//# sourceMappingURL=definitions.d.ts.map