@vectros-ai/blueprints 0.5.0

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to `@vectros-ai/blueprints` are documented here.
+This project adheres to [Semantic Versioning](https://semver.org).
+
+## 0.5.0 — 2026-06-20
+
+Initial public release of the Vectros blueprints library.
+
+### Added
+
+- Curated, ready-to-apply use-case blueprints — each bundling a schema set, a
+  least-privilege AccessProfile, and seed data: `task-management`,
+  `coding-agent-memory`, `second-brain`, and `clinical-intake`.
+- The Blueprint format and a structural validation API for authoring your own —
+  including field validation, render hints, sensitive (PHI) fields, typed
+  `reference` links between record types, and the lookup-index surface (equality
+  and ordered range/prefix lookups, the 7-slot budget, and uniqueness).

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 reasonable and customary use in 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 2026 Vectros
+
+   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,179 @@
+# @vectros-ai/blueprints
+
+The Vectros **blueprint** format + the curated bundled library.
+
+A **blueprint** is a versioned, reviewed bundle for one use case: a schema
+set + a **least-privilege** AccessProfile + a service principal + optional
+seed data, all with stable identifiers so applying it twice converges
+instead of duplicating. [`@vectros-ai/cli`](https://www.npmjs.com/package/@vectros-ai/cli)
+`bootstrap` applies them to provision a ready-to-use data model + a narrow
+`ssk_*`.
+
+This package is **data + types + structural validation only**. It contains
+**no enforcement**: the security boundary — the scope gate that bounds a
+blueprint's requested scopes to data-plane-only — lives in the CLI binary
+(the trust boundary), because blueprints are untrusted
+input.
+
+```ts
+import {
+  BUNDLED_BLUEPRINTS,
+  getBlueprint,
+  parseBlueprintJson,
+  type Blueprint,
+} from '@vectros-ai/blueprints';
+
+const tm = getBlueprint('task-management');    // a bundled Blueprint
+const mine = parseBlueprintJson(jsonText);     // parse + validate untrusted JSON (throws on bad shape)
+```
+
+`parseBlueprintJson` takes a JSON **string**; `parseBlueprint` validates an
+already-parsed object. Both throw `BlueprintValidationError` on a bad shape.
+
+## Exports
+
+- `Blueprint` + field/schema/seed types — the format.
+- `parseBlueprint(input)` / `parseBlueprintJson(json)` — structural (zod)
+  validation; throws `BlueprintValidationError` on a malformed shape.
+- `contextNameOf(blueprint)` — the app-context display name. Falls back to
+  `MCP — <name>` when the blueprint omits `contextName`.
+- `BUNDLED_BLUEPRINTS` / `BLUEPRINT_NAMES` / `getBlueprint(name)` — the
+  curated library: `task-management` (the minimal authoring exemplar),
+  `coding-agent-memory`, `second-brain`, and `clinical-intake` (the flagship
+  use-case blueprints).
+
+## The format, field by field
+
+This is the format *contract* reference. For the authoring *workflow*
+(`init` → `validate` → `plan` → `bootstrap`), see
+[`@vectros-ai/cli`'s AUTHORING.md](https://www.npmjs.com/package/@vectros-ai/cli).
+
+A schema's `fields[]` carry, beyond the basics (`fieldId`, `fieldType`,
+`required`, `searchable`, `filterable`, `enumValues`, `description`):
+
+- **`validation`** — server-enforced rules mirroring the platform
+  `ValidationRules`: `minLength` / `maxLength` / `min` / `max` / `pattern` /
+  `email` / `url` / `phone` / `step` / `multipleOf` / `minItems` / `maxItems` /
+  `required`. Strict — an unknown rule key is an authoring error.
+- **`renderHints`** — `label` / `widget` (`text|textarea|select|date|checkbox`) /
+  `order` / `section` / `helpText` / `displayField` (mark the record's headline
+  column — at most one per schema). Authored per-field; the CLI loader pivots
+  them into the schema-level keyed map the platform expects.
+- **`sensitive`** (boolean, default false) — marks a field as PHI/PII. The
+  platform redacts it from logs/audit/errors **at write time** (destroyed before
+  the audit snapshot — not reversible masking), blind-indexes it for lookups,
+  **excludes it from the search index**, and masks it in responses unless the token
+  carries the `s` reveal scope for the record type. The bundled `clinical-intake`
+  blueprint is the exemplar. (Marking a field both `sensitive` and `searchable` is
+  contradictory — a sensitive field never enters the search index.)
+
+A schema additionally accepts:
+
+- **`lookupFields`** — each entry is either a bare field name (`"status"`) or an
+  object `{ fieldName, unique?, rangeEnabled?, sortBy?, allowOverflow? }`. The
+  index shape is **migration-locked** — you cannot change it once the schema is
+  live, even by removing and re-adding the field — so choose deliberately:
+  - `unique` enforces a uniqueness constraint.
+  - **equality (default) vs. `rangeEnabled`** — equality for ids/foreign keys/
+    status enums/categories; `rangeEnabled` (ordered `from`/`to`/`prefix`, billed
+    at the range rate) for values you query as an order (**dates, sequences,
+    scores, versions**). Range/prefix order is lexical, so ISO-8601 dates sort
+    correctly but an ordinal enum (`low…urgent`) would sort alphabetically — leave
+    those as equality.
+  - **7-slot budget** — a schema has 7 fast equality-lookup slots (ownership ids +
+    `externalId` ride their own; `rangeEnabled` lookups use a row, not a slot, so
+    they don't count). An 8th equality lookup is rejected unless it sets
+    `allowOverflow` (a higher-cost secondary index).
+  - `sortBy` sets the equality-lookup listing order (`createdAt` default,
+    `lastUpdated`, or a declared field). Sorting by an **optional** field silently
+    drops records lacking it — prefer the always-present timestamps.
+  - **Sensitive fields may be equality lookups** (HMAC blind index → exact
+    find-by-value without storing the value in the clear), but never `rangeEnabled`
+    (a hash is not orderable), and no `sortBy` may name a sensitive field.
+  Max 10. Do **not** list a reserved identifier (`externalId` or an ownership id) —
+  those have first-class finders, so the platform rejects redeclaring them as
+  schema lookups.
+- **`capabilities`** — today `{ auditHistory }`; defaults to `true` on the
+  platform when omitted. Surface it to make the audit posture self-documenting.
+- **`active`** — whether the schema accepts new records (inactive schemas reject
+  creation). Defaults to active.
+- **`userId` / `orgId` / `clientId`** — schema-level ownership defaults (flat,
+  mirroring the platform `SchemaRequest`). With a scoped token these must be
+  consistent with the profile's `dataScope`.
+
+The `accessProfile.dataScope` value lists accept a **`null` sentinel** — e.g.
+`{ orgId: ["org_x", null] }` grants `org_x`'s records **plus** tenant-level
+(owner-less / shared) records. Omitting `null` restricts the key to the listed
+owners only.
+
+All of the above are **optional and backward-compatible** — a blueprint that
+omits them parses and provisions exactly as before.
+
+## Authoring
+
+Drop a `blueprints/<name>.ts` exporting a `Blueprint` default, register it in
+`src/index.ts`. The bundled-library test guards that every blueprint parses;
+the CLI's scope-gate test guards that every bundled blueprint stays
+data-plane-only. The bundled `task-management` blueprint is the
+heavily-commented exemplar — copy it to start.
+
+**`fieldType` must be a platform-supported type** — one of `string`, `number`,
+`boolean`, `date`, `enum`, `array`, `object`, `reference`.
+The format keeps `fieldType` a free-form string for forward-compat, so an unsupported
+value (e.g. `string[]` — a string array is **`array`**) parses fine but **400s at
+`createSchema`** on a live apply. The bundled-library tests include a `fieldType`
+allowlist guard so this fails at PR time, not on apply.
+
+**Authoring a `reference` field.** A field with `fieldType: 'reference'` declares a typed
+link to another record. The blueprint format carries these extra authoring keys:
+
+- `targetTypeName` (**required**) — the `typeName` the link points at.
+- `targetSurface` (**required**) — which surface the target lives on
+  (`record` | `document` | `user` | `org` | `client`). The same `typeName` can exist on
+  more than one surface, so this disambiguates which lookup resolves the link. (Omitting
+  it 400s at `createSchema` — "requires targetSurface".)
+- `targetField` (optional) — the field on the target used to resolve the link; defaults
+  (platform side) to the target's `externalId` / lookup key when omitted. Must name a
+  **unique** lookup on the target type.
+- `cardinality` (optional) — `one` (default) or `many`.
+
+```ts
+{
+  fieldId: 'authorId',
+  fieldType: 'reference',
+  targetTypeName: 'author',
+  targetSurface: 'record',
+  targetField: 'externalId',
+  cardinality: 'one',
+}
+```
+
+Write-time existence of the target **is** enforced by default — a referencing record can
+only be written once its target exists (so seed the target first). There is no
+reverse-reference index on this surface; to query "which records reference X", add the
+reference field to `lookupFields` as an equality lookup. The bundled `coding-agent-memory`
+blueprint is the exemplar (a `convention` links to the `decision` that established it).
+
+## Testing a blueprint
+
+Blueprints are tested **like code**, in three layers:
+
+1. **Change-time (every PR, no creds):** the `@vectros-ai/cli` unit suite runs every
+   `BUNDLED_BLUEPRINT` through the harness core (snapshot → apply → assert → teardown)
+   with a fake client, plus the structural + scope-gate + `fieldType` guards here. A
+   new blueprint the loader can't provision fails here.
+2. **Post-deploy canary:** one bundled blueprint runs a live `blueprint-test` in the
+   CLI staging smoke to catch unrelated API-contract regressions.
+3. **Live credential proof (one-time, on a new/changed blueprint):**
+   `vectros blueprint-test <name>` against your tenant (apply → assert a real `ssk_*`
+   ping → created-only teardown). Needs a bootstrap token — see the `@vectros-ai/cli`
+   docs.
+
+> ⚠️ Applying a blueprint that declares its **own new `contextId`** requires a bootstrap
+> token with authority to **create** that app-context. A token pinned to an existing
+> context can't create a new one, so the apply step will fail — bootstrap into an existing
+> context, or use a token with context-creation authority.
+
+## License
+
+Apache-2.0. See the LICENSE file.