@nstarkman/research-kit 0.0.0-stage → 20261023.0.1

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+Versions are dates, `YYYYMMDD.0.N`; the four research-kit packages are released together at one
+version. A breaking change says how to migrate.
+
+## 20261023.0.1
+
+### Fixed
+
+- Released with `@nstarkman/data-resolver` 20261023.0.1 (a paper's map: its own co-authors only).
+
+## 20261023.0.0
+
+First release.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nathaniel Starkman
+
+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,3 +1,55 @@
-# Temporary Holding Version
+# @nstarkman/research-kit
 
-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.
+The [nstarkman.space](https://nstarkman.space) paper card, publication entry and collaborator map,
+for a paper's own site at `nstarkman.space/<repo>/` (made with
+[syw-site](https://github.com/nstarman/syw-site)). It is three packages at one version:
+`@nstarkman/data-resolver` (the data layer as a store, and the collector), `@nstarkman/card-builder`
+(`Card`, `Publication`), `@nstarkman/collaborator-map` (`CollabMap`). Developed in
+[nstarman/nstarman.github.io](https://github.com/nstarman/nstarman.github.io), whose pages use them.
+
+```bash
+npm install --save-exact @nstarkman/research-kit@<version>
+```
+
+## A snapshot, then a store
+
+```js
+import { collect } from '@nstarkman/research-kit/collect.js';
+import { fromGitHub } from '@nstarkman/research-kit/readers.js';
+const snapshot = await collect('stream-convexity-spatial', fromGitHub({ repo: 'nstarman/nstarman.github.io' }));
+```
+
+The snapshot (schema 1) is the item and the items its `refs` reach, as they are in the website's
+`data/`, with the `config/` slices they use and the commit they came from. Keep it in the repository
+and build offline.
+
+## The store the components read
+
+The components import `@nstarkman/research-store`. Point it at a module that builds the store and
+exports its names, and let Vite load the packages — in dev and in the build — or Node loads them and
+cannot find the store:
+
+```js
+// astro.config.mjs
+vite: {
+  resolve: { alias: { '@nstarkman/research-store': fileURLToPath(new URL('./src/store.js', import.meta.url)) } },
+  ssr: { noExternal: [/^@nstarkman\//] },                                        // dev
+  environments: { prerender: { resolve: { noExternal: [/^@nstarkman\//] } } },  // build (Astro 7)
+}
+```
+
+```js
+// src/store.js
+import { createStore } from '@nstarkman/research-kit/store.js';
+import snapshot from '../card.json';
+export const store = createStore(snapshot);
+export const { items, lists, config, byType, resolve, authors, links /* … every name of the store */ } = store;
+```
+
+Then `<Publication item={resolve(id)} abstract card="paperSite" />` and `<CollabMap />`. The page
+needs `@nstarkman/site-layout`'s stylesheet, which carries the card's rules.
+
+## Versions
+
+`YYYYMMDD.0.N`, the four packages together; fixes are backported to every release with the bug.
+See `CHANGELOG.md`.

package/package.json

@@ -1,6 +1,33 @@
 {
   "name": "@nstarkman/research-kit",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "20261023.0.1",
+  "description": "The nstarkman.space card, collaborator map and data resolver, at one version.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Nathaniel Starkman",
+  "homepage": "https://nstarkman.space",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nstarman/nstarman.github.io.git",
+    "directory": "packages/research-kit"
+  },
+  "keywords": [
+    "astro-component"
+  ],
+  "exports": {
+    "./*": "./src/*"
+  },
+  "files": [
+    "src",
+    "CHANGELOG.md"
+  ],
+  "dependencies": {
+    "@nstarkman/data-resolver": "20261023.0.1",
+    "@nstarkman/card-builder": "20261023.0.1",
+    "@nstarkman/collaborator-map": "20261023.0.1"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}

package/src/Card.astro

@@ -0,0 +1,5 @@
+---
+// @nstarkman/card-builder's Card, at this kit's version.
+import Card from '@nstarkman/card-builder/Card.astro';
+---
+<Card {...Astro.props} />

package/src/CollabMap.astro

@@ -0,0 +1,5 @@
+---
+// @nstarkman/collaborator-map's map, at this kit's version.
+import CollabMap from '@nstarkman/collaborator-map/CollabMap.astro';
+---
+<CollabMap {...Astro.props} />

package/src/Publication.astro

@@ -0,0 +1,5 @@
+---
+// @nstarkman/card-builder's Publication, at this kit's version.
+import Publication from '@nstarkman/card-builder/Publication.astro';
+---
+<Publication {...Astro.props} />

package/src/collect.js

@@ -0,0 +1,2 @@
+// @nstarkman/data-resolver's collect.js, at this kit's version.
+export * from '@nstarkman/data-resolver/collect.js';

package/src/readers.js

@@ -0,0 +1,2 @@
+// @nstarkman/data-resolver's readers.js, at this kit's version.
+export * from '@nstarkman/data-resolver/readers.js';

package/src/store.js

@@ -0,0 +1,2 @@
+// @nstarkman/data-resolver's store.js, at this kit's version.
+export * from '@nstarkman/data-resolver/store.js';