@intentset/publisher 0.6.1 → 0.7.0

package/README.md

@@ -0,0 +1,39 @@
+# @intentset/publisher
+
+Publishes reviewed knowledge for one audience and release (`spec/publication.md`): it projects the graph deny by
+default, checks that no excluded record's title or path leaks, and writes Markset documents with their provenance,
+an index, retrieval chunks, and `help.json`, the tips a product shows beside its controls.
+
+## Install
+
+```sh
+npm install @intentset/publisher
+pnpm add @intentset/publisher
+```
+
+## Example
+
+Most repositories publish through the CLI, `@intentset/cli`:
+
+```sh
+npx -p @intentset/cli intentset publish --visibility customer --audience teacher --product PRD-LANTERN \
+  --release pilot-1 --role teacher --edition standard --out published/ --html
+```
+
+With pnpm, `pnpm dlx --package=@intentset/cli intentset …`, or `pnpm exec intentset …` once `@intentset/cli` is
+installed. The command is always `@intentset/cli`'s: this package has no `intentset` binary, and npx asked
+for `intentset` alone would fetch an unrelated unscoped package from the registry.
+
+From code, `publish(graph, registries, request, { snapshot, publishedAt })` returns the documents, the index, the help
+file and the diagnostics, and refuses the whole request when any field is missing or undeclared (PUB001).
+`@intentset/help` reads the help file in the product.
+
+## Learn more
+
+Part of [Intentset](https://intentset.org/), which keeps product intent connected to the code that delivers it and the
+checks that verify it, as readable Markdown files in a repository. The specifications are at
+https://intentset.org/specifications/ and the source at https://github.com/intentset/intentset.
+
+## Licence
+
+MIT

package/dist/generate.d.ts

@@ -4,7 +4,7 @@
  *
  * The document is the knowledge body, unchanged, under frontmatter that
  * carries `markset: 0` and a top-level `intentset-publication` block: the
- * generated profile `intentset/publication/0.1`, marked derived, with the
+ * generated profile `intentset/publication/0.2`, marked derived, with the
  * provenance Core §9 requires. It is a top-level key, not `intentset:`, so
  * nothing reads a generated document as a canonical record. A comment line
  * after the frontmatter says the same to a person opening the file.
@@ -22,7 +22,7 @@
 import type { Artifact, Diagnostic, Graph, Visibility } from "@intentset/core";
 import type { Snapshot } from "./project.ts";
 import { type PublicationRequest } from "./request.ts";
-export declare const PUBLICATION_PROFILE = "intentset/publication/0.1";
+export declare const PUBLICATION_PROFILE = "intentset/publication/0.2";
 /** The top-level frontmatter key of a generated document. */
 export declare const PUBLICATION_KEY = "intentset-publication";
 export interface SourceStamp {

package/dist/generate.js

@@ -4,7 +4,7 @@ import { bodyLineOffset } from "./body.js";
 import { publicationDiagnostic, sortedUnique } from "./diagnostic.js";
 import { admits } from "./request.js";
 import { emitYaml } from "./yaml.js";
-export const PUBLICATION_PROFILE = "intentset/publication/0.1";
+export const PUBLICATION_PROFILE = "intentset/publication/0.2";
 /** The top-level frontmatter key of a generated document. */
 export const PUBLICATION_KEY = "intentset-publication";
 /** The line after the frontmatter that marks a generated file. */

package/dist/help.d.ts

@@ -14,7 +14,7 @@
 import type { Graph, Visibility } from "@intentset/core";
 import type { Snapshot } from "./project.ts";
 import type { PublicationRequest } from "./request.ts";
-export declare const HELP_PROFILE = "intentset/help/0.1";
+export declare const HELP_PROFILE = "intentset/help/0.2";
 /** The file's name beside the published documents. */
 export declare const HELP_FILE = "help.json";
 export interface HelpKnowledge {

package/dist/help.js

@@ -1,5 +1,5 @@
 import { compareStrings } from "./diagnostic.js";
-export const HELP_PROFILE = "intentset/help/0.1";
+export const HELP_PROFILE = "intentset/help/0.2";
 /** The file's name beside the published documents. */
 export const HELP_FILE = "help.json";
 /** The help file for the documents a run published, which are given by knowledge ID. */

package/package.json

@@ -1,7 +1,14 @@
 {
   "name": "@intentset/publisher",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Audience and release projection of reviewed knowledge into Markset documents with provenance.",
+  "keywords": [
+    "intentset",
+    "publishing",
+    "documentation",
+    "markset",
+    "knowledge-base"
+  ],
   "license": "MIT",
   "type": "module",
   "engines": {
@@ -28,8 +35,8 @@
     }
   },
   "dependencies": {
-    "@intentset/core": "^0.6.1",
-    "@intentset/markset-adapter": "^0.6.1",
+    "@intentset/core": "^0.7.0",
+    "@intentset/markset-adapter": "^0.7.0",
     "@markset-lang/parser": "0.4.1",
     "@markset-lang/render-html": "0.4.1"
   }

package/src/generate.ts

@@ -4,7 +4,7 @@
  *
  * The document is the knowledge body, unchanged, under frontmatter that
  * carries `markset: 0` and a top-level `intentset-publication` block: the
- * generated profile `intentset/publication/0.1`, marked derived, with the
+ * generated profile `intentset/publication/0.2`, marked derived, with the
  * provenance Core §9 requires. It is a top-level key, not `intentset:`, so
  * nothing reads a generated document as a canonical record. A comment line
  * after the frontmatter says the same to a person opening the file.
@@ -28,7 +28,7 @@ import type { Snapshot } from "./project.ts";
 import { type PublicationRequest, admits } from "./request.ts";
 import { type YamlValue, emitYaml } from "./yaml.ts";
 
-export const PUBLICATION_PROFILE = "intentset/publication/0.1";
+export const PUBLICATION_PROFILE = "intentset/publication/0.2";
 /** The top-level frontmatter key of a generated document. */
 export const PUBLICATION_KEY = "intentset-publication";
 

package/src/help.ts

@@ -16,7 +16,7 @@ import { compareStrings } from "./diagnostic.ts";
 import type { Snapshot } from "./project.ts";
 import type { PublicationRequest } from "./request.ts";
 
-export const HELP_PROFILE = "intentset/help/0.1";
+export const HELP_PROFILE = "intentset/help/0.2";
 /** The file's name beside the published documents. */
 export const HELP_FILE = "help.json";