@stream44.studio/t44-blockchaincommons.com 0.1.0-rc.2

package/caps/provenance-mark-cli.test.ts

@@ -0,0 +1,387 @@
+#!/usr/bin/env bun test
+
+import * as bunTest from 'bun:test'
+import { run } from 't44/workspace-rt'
+import { join } from 'path'
+import { rm, mkdir } from 'fs/promises'
+
+const WORK_DIR = join(import.meta.dir, '.~provenance-mark-cli')
+
+const {
+    test: { describe, it, expect },
+    cli,
+} = await run(async ({ encapsulate, CapsulePropertyTypes, makeImportStack }: any) => {
+    const spine = await encapsulate({
+        '#@stream44.studio/encapsulate/spine-contracts/CapsuleSpineContract.v0': {
+            '#@stream44.studio/encapsulate/structs/Capsule': {},
+            '#': {
+                test: {
+                    type: CapsulePropertyTypes.Mapping,
+                    value: 't44/caps/WorkspaceTest',
+                    options: {
+                        '#': {
+                            bunTest,
+                            env: {}
+                        }
+                    }
+                },
+                cli: {
+                    type: CapsulePropertyTypes.Mapping,
+                    value: './provenance-mark-cli'
+                },
+            }
+        }
+    }, {
+        importMeta: import.meta,
+        importStack: makeImportStack(),
+        capsuleName: 't44/caps/providers/blockchaincommons.com/provenance-mark-cli.test'
+    })
+    return { spine }
+}, async ({ spine, apis }: any) => {
+    return apis[spine.capsuleSourceLineRef]
+}, {
+    importMeta: import.meta
+})
+
+const fs = await import('fs')
+const path = await import('path')
+
+// Clean up before tests
+await rm(WORK_DIR, { recursive: true, force: true })
+await mkdir(WORK_DIR, { recursive: true })
+
+describe('Provenance Mark CLI Capsule', function () {
+
+    let chainDir: string
+
+    // ──────────────────────────────────────────────────────────────────
+    // 1. Create a new chain (provenance new)
+    // ──────────────────────────────────────────────────────────────────
+
+    describe('1. New chain', function () {
+
+        it('should create a new provenance mark chain with default resolution', async function () {
+            chainDir = path.join(WORK_DIR, 'mychain')
+
+            const output = await cli.newChain({
+                path: chainDir,
+                comment: 'Genesis mark for tests',
+                date: new Date(Date.UTC(2025, 0, 1)),
+                quiet: true,
+            })
+
+            expect(typeof output).toBe('string')
+            expect(output.length).toBeGreaterThan(0)
+
+            // Verify directory structure
+            expect(fs.existsSync(chainDir)).toBe(true)
+            expect(fs.existsSync(path.join(chainDir, 'generator.json'))).toBe(true)
+            expect(fs.existsSync(path.join(chainDir, 'marks'))).toBe(true)
+            expect(fs.existsSync(path.join(chainDir, 'marks', 'mark-0.json'))).toBe(true)
+        })
+
+        it('should create a chain with a specific resolution', async function () {
+            const highResDir = path.join(WORK_DIR, 'highres-chain')
+
+            const output = await cli.newChain({
+                path: highResDir,
+                resolution: 'high',
+                comment: 'High resolution chain',
+                date: new Date(Date.UTC(2025, 0, 1)),
+                quiet: true,
+            })
+
+            expect(output.length).toBeGreaterThan(0)
+            expect(fs.existsSync(path.join(highResDir, 'marks', 'mark-0.json'))).toBe(true)
+        })
+
+        it('should reject creating a chain in an existing directory', async function () {
+            await expect(
+                cli.newChain({
+                    path: chainDir,
+                    comment: 'Duplicate',
+                    date: new Date(Date.UTC(2025, 0, 1)),
+                })
+            ).rejects.toThrow('already exists')
+        })
+    })
+
+    // ──────────────────────────────────────────────────────────────────
+    // 2. Add marks (provenance next)
+    // ──────────────────────────────────────────────────────────────────
+
+    describe('2. Next mark', function () {
+
+        it('should add a second mark to the chain', async function () {
+            const output = await cli.nextMark({
+                path: chainDir,
+                comment: 'Release v1.0',
+                date: new Date(Date.UTC(2025, 0, 2)),
+                quiet: true,
+            })
+
+            expect(typeof output).toBe('string')
+            expect(output.length).toBeGreaterThan(0)
+            expect(fs.existsSync(path.join(chainDir, 'marks', 'mark-1.json'))).toBe(true)
+        })
+
+        it('should add a third mark to the chain', async function () {
+            const output = await cli.nextMark({
+                path: chainDir,
+                comment: 'Release v2.0',
+                date: new Date(Date.UTC(2025, 0, 3)),
+                quiet: true,
+            })
+
+            expect(output.length).toBeGreaterThan(0)
+            expect(fs.existsSync(path.join(chainDir, 'marks', 'mark-2.json'))).toBe(true)
+        })
+
+        it('should add a fourth mark to the chain', async function () {
+            await cli.nextMark({
+                path: chainDir,
+                comment: 'Release v3.0',
+                date: new Date(Date.UTC(2025, 0, 4)),
+                quiet: true,
+            })
+
+            expect(fs.existsSync(path.join(chainDir, 'marks', 'mark-3.json'))).toBe(true)
+        })
+    })
+
+    // ──────────────────────────────────────────────────────────────────
+    // 3. Output formats (provenance next --format)
+    // ──────────────────────────────────────────────────────────────────
+
+    describe('3. Output formats', function () {
+
+        it('should output in markdown format', async function () {
+            const formatDir = path.join(WORK_DIR, 'format-chain')
+            await cli.newChain({
+                path: formatDir,
+                comment: 'Format test',
+                date: new Date(Date.UTC(2025, 0, 1)),
+                format: 'markdown',
+                quiet: true,
+            })
+
+            // Markdown output contains the bytewords line with 🅟
+            expect(true).toBe(true) // chain created successfully
+        })
+
+        it('should output in UR format', async function () {
+            const urDir = path.join(WORK_DIR, 'ur-chain')
+            const output = await cli.newChain({
+                path: urDir,
+                comment: 'UR test',
+                date: new Date(Date.UTC(2025, 0, 1)),
+                format: 'ur',
+                quiet: true,
+            })
+
+            expect(output.startsWith('ur:provenance/')).toBe(true)
+        })
+
+        it('should output in JSON format', async function () {
+            const jsonDir = path.join(WORK_DIR, 'json-chain')
+            const output = await cli.newChain({
+                path: jsonDir,
+                comment: 'JSON test',
+                date: new Date(Date.UTC(2025, 0, 1)),
+                format: 'json',
+                quiet: true,
+            })
+
+            const parsed = JSON.parse(output)
+            expect(parsed).toBeDefined()
+            expect(parsed.comment).toBe('JSON test')
+        })
+
+        it('should output next mark in UR format', async function () {
+            const urDir = path.join(WORK_DIR, 'ur-chain')
+            const output = await cli.nextMark({
+                path: urDir,
+                comment: 'UR next',
+                date: new Date(Date.UTC(2025, 0, 2)),
+                format: 'ur',
+                quiet: true,
+            })
+
+            expect(output.startsWith('ur:provenance/')).toBe(true)
+        })
+
+        it('should output next mark in JSON format', async function () {
+            const jsonDir = path.join(WORK_DIR, 'json-chain')
+            const output = await cli.nextMark({
+                path: jsonDir,
+                comment: 'JSON next',
+                date: new Date(Date.UTC(2025, 0, 2)),
+                format: 'json',
+                quiet: true,
+            })
+
+            const parsed = JSON.parse(output)
+            expect(parsed.comment).toBe('JSON next')
+        })
+    })
+
+    // ──────────────────────────────────────────────────────────────────
+    // 4. Print marks (provenance print)
+    // ──────────────────────────────────────────────────────────────────
+
+    describe('4. Print marks', function () {
+
+        it('should print all marks in the chain', async function () {
+            const output = await cli.print({
+                path: chainDir,
+            })
+
+            expect(typeof output).toBe('string')
+            expect(output.length).toBeGreaterThan(0)
+        })
+
+        it('should print a specific range of marks', async function () {
+            const output = await cli.print({
+                path: chainDir,
+                start: 0,
+                end: 1,
+            })
+
+            expect(output.length).toBeGreaterThan(0)
+        })
+
+        it('should print only the genesis mark', async function () {
+            const output = await cli.print({
+                path: chainDir,
+                start: 0,
+                end: 0,
+            })
+
+            expect(output.length).toBeGreaterThan(0)
+        })
+
+        it('should print marks in JSON format', async function () {
+            const output = await cli.print({
+                path: chainDir,
+                format: 'json',
+            })
+
+            const parsed = JSON.parse(output)
+            expect(Array.isArray(parsed)).toBe(true)
+            expect(parsed.length).toBe(4)
+        })
+
+        it('should print marks in UR format', async function () {
+            const output = await cli.print({
+                path: chainDir,
+                format: 'ur',
+            })
+
+            const lines = output.split('\n').filter((l: string) => l.trim() !== '')
+            expect(lines.length).toBe(4)
+            for (const line of lines) {
+                expect(line.startsWith('ur:provenance/')).toBe(true)
+            }
+        })
+    })
+
+    // ──────────────────────────────────────────────────────────────────
+    // 5. Validate chain (provenance validate)
+    // ──────────────────────────────────────────────────────────────────
+
+    describe('5. Validate chain', function () {
+
+        it('should validate a valid chain directory', async function () {
+            const output = await cli.validate({
+                dir: chainDir,
+                format: 'json-pretty',
+            })
+
+            const parsed = JSON.parse(output)
+            expect(parsed).toBeDefined()
+            expect(parsed.chains).toBeDefined()
+        })
+
+        it('should validate with text format (empty for valid chain)', async function () {
+            const output = await cli.validate({
+                dir: chainDir,
+                format: 'text',
+            })
+
+            // A valid chain produces empty text output (no issues)
+            expect(typeof output).toBe('string')
+        })
+
+        it('should validate with json-compact format', async function () {
+            const output = await cli.validate({
+                dir: chainDir,
+                format: 'json-compact',
+            })
+
+            const parsed = JSON.parse(output)
+            expect(parsed).toBeDefined()
+        })
+    })
+
+    // ──────────────────────────────────────────────────────────────────
+    // 6. Resolution levels
+    // ──────────────────────────────────────────────────────────────────
+
+    describe('6. Resolution levels', function () {
+
+        for (const resolution of ['low', 'medium', 'quartile', 'high'] as const) {
+            it(`should create a chain with ${resolution} resolution`, async function () {
+                const resDir = path.join(WORK_DIR, `res-${resolution}`)
+                const output = await cli.newChain({
+                    path: resDir,
+                    resolution,
+                    comment: `${resolution} resolution`,
+                    date: new Date(Date.UTC(2025, 0, 1)),
+                    format: 'json',
+                    quiet: true,
+                })
+
+                const parsed = JSON.parse(output)
+                expect(parsed).toBeDefined()
+                expect(parsed.comment).toBe(`${resolution} resolution`)
+            })
+        }
+    })
+
+    // ──────────────────────────────────────────────────────────────────
+    // 7. Mark JSON structure
+    // ──────────────────────────────────────────────────────────────────
+
+    describe('7. Mark JSON structure', function () {
+
+        it('should have expected fields in mark JSON', async function () {
+            const output = await cli.print({
+                path: chainDir,
+                start: 0,
+                end: 0,
+                format: 'json',
+            })
+
+            const parsed = JSON.parse(output)
+            expect(Array.isArray(parsed)).toBe(true)
+            const mark = parsed[0]
+
+            expect(mark.comment).toBe('Genesis mark for tests')
+            expect(mark.mark).toBeDefined()
+        })
+
+        it('should preserve comments across marks', async function () {
+            const output = await cli.print({
+                path: chainDir,
+                format: 'json',
+            })
+
+            const parsed = JSON.parse(output)
+            expect(parsed[0].comment).toBe('Genesis mark for tests')
+            expect(parsed[1].comment).toBe('Release v1.0')
+            expect(parsed[2].comment).toBe('Release v2.0')
+            expect(parsed[3].comment).toBe('Release v3.0')
+        })
+    })
+
+})

package/caps/provenance-mark-cli.ts

@@ -0,0 +1,174 @@
+
+import {
+    NewCommand,
+    NextCommand,
+    PrintCommand,
+    ValidateCommand,
+    OutputFormat,
+    Resolution,
+    ValidateFormat,
+    type NewCommandArgs,
+    type NextCommandArgs,
+    type PrintCommandArgs,
+    type ValidateCommandArgs,
+    defaultNewCommandArgs,
+    defaultNextCommandArgs,
+    defaultPrintCommandArgs,
+    defaultValidateCommandArgs,
+} from '@bcts/provenance-mark-cli'
+
+
+export async function capsule({
+    encapsulate,
+    CapsulePropertyTypes,
+    makeImportStack
+}: {
+    encapsulate: any
+    CapsulePropertyTypes: any
+    makeImportStack: any
+}) {
+
+    return encapsulate({
+        '#@stream44.studio/encapsulate/spine-contracts/CapsuleSpineContract.v0': {
+            '#@stream44.studio/encapsulate/structs/Capsule': {},
+            '#': {
+
+                newChain: {
+                    type: CapsulePropertyTypes.Function,
+                    value: async function (this: any, context: {
+                        path: string
+                        resolution?: 'low' | 'medium' | 'quartile' | 'high'
+                        comment?: string
+                        date?: Date
+                        seed?: string
+                        format?: 'markdown' | 'ur' | 'json'
+                        quiet?: boolean
+                    }) {
+                        const args: NewCommandArgs = {
+                            ...defaultNewCommandArgs(),
+                            path: context.path,
+                        }
+                        if (context.resolution) {
+                            args.resolution = context.resolution as Resolution
+                        }
+                        if (context.comment !== undefined) {
+                            args.comment = context.comment
+                        }
+                        if (context.date) {
+                            args.date = context.date
+                        }
+                        if (context.format) {
+                            args.format = context.format as OutputFormat
+                        }
+                        if (context.quiet !== undefined) {
+                            args.quiet = context.quiet
+                        }
+                        const cmd = new NewCommand(args)
+                        return cmd.exec()
+                    }
+                },
+
+                nextMark: {
+                    type: CapsulePropertyTypes.Function,
+                    value: async function (this: any, context: {
+                        path: string
+                        comment?: string
+                        date?: Date
+                        format?: 'markdown' | 'ur' | 'json'
+                        quiet?: boolean
+                    }) {
+                        const args: NextCommandArgs = {
+                            ...defaultNextCommandArgs(),
+                            path: context.path,
+                        }
+                        if (context.comment !== undefined) {
+                            args.comment = context.comment
+                        }
+                        if (context.date) {
+                            args.date = context.date
+                        }
+                        if (context.format) {
+                            args.format = context.format as OutputFormat
+                        }
+                        if (context.quiet !== undefined) {
+                            args.quiet = context.quiet
+                        }
+                        const cmd = new NextCommand(args)
+                        return cmd.exec()
+                    }
+                },
+
+                print: {
+                    type: CapsulePropertyTypes.Function,
+                    value: async function (this: any, context: {
+                        path: string
+                        start?: number
+                        end?: number
+                        format?: 'markdown' | 'ur' | 'json'
+                    }) {
+                        const args: PrintCommandArgs = {
+                            ...defaultPrintCommandArgs(),
+                            path: context.path,
+                        }
+                        if (context.start !== undefined) {
+                            args.start = context.start
+                        }
+                        if (context.end !== undefined) {
+                            args.end = context.end
+                        }
+                        if (context.format) {
+                            args.format = context.format as OutputFormat
+                        }
+                        const cmd = new PrintCommand(args)
+                        return cmd.exec()
+                    }
+                },
+
+                validate: {
+                    type: CapsulePropertyTypes.Function,
+                    value: async function (this: any, context: {
+                        dir?: string
+                        marks?: string[]
+                        warn?: boolean
+                        format?: 'text' | 'json-compact' | 'json-pretty'
+                    }) {
+                        const args: ValidateCommandArgs = {
+                            ...defaultValidateCommandArgs(),
+                        }
+                        if (context.dir) {
+                            args.dir = context.dir
+                        }
+                        if (context.marks) {
+                            args.marks = context.marks
+                        }
+                        if (context.warn !== undefined) {
+                            args.warn = context.warn
+                        }
+                        if (context.format) {
+                            args.format = context.format as ValidateFormat
+                        }
+                        const cmd = new ValidateCommand(args)
+                        return cmd.exec()
+                    }
+                },
+
+                types: {
+                    type: CapsulePropertyTypes.Function,
+                    value: async function (this: any) {
+                        return {
+                            OutputFormat,
+                            Resolution,
+                            ValidateFormat,
+                        }
+                    }
+                },
+
+            }
+        }
+    }, {
+        importMeta: import.meta,
+        importStack: makeImportStack(),
+        capsuleName: capsule['#'],
+    })
+}
+capsule['#'] = 't44/caps/providers/blockchaincommons.com/provenance-mark-cli'