@juli-os/ledger 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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

@@ -1,3 +1,62 @@
-# Temporary Holding Version
+# @juli-os/ledger — L1 Ledger Layer (peel validation slice)
 
-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 L1 layer of the juli open-source ladder: **the append-only ledger of record for agent work**. Zero npm dependencies — persistence uses Node's built-in `node:sqlite`.
+
+## What's inside
+
+| Capability | API | What it gives you |
+|---|---|---|
+| Workflow lifecycle | `createLedgerStore(path)` → `createWorkflow / getWorkflow / listWorkflows / setWorkflowStatus / createStep / insertStepsAt …` | Durable jobs + steps + statuses in SQLite, with dynamic mid-flight step insertion (single transaction, tail renumbered) |
+| Conversation threading | `latestByMessageId(msgId)` / `recentBySender(from, since)` | Reply-chain matching for email bots and support inboxes — message-id causal anchor + sender/time-window candidate narrowing |
+| Case files | `emptyCaseFile() / loadCaseFile / saveCaseFile` | A per-job audit dossier: original → extract → executions → draft → decisions → artifacts |
+| Usage & cost | `createUsageStore(path)` → `record / stats / timeline / byLocalDay`, `priceUsage()` | Token accounting per model / day / session with built-in pricing |
+
+## Peel boundary
+
+Files are copied **verbatim** from the juli monorepo (import paths unchanged — the tree shape keeps them valid):
+
+| File | Origin |
+|---|---|
+| `src/platform/ledger/{store,usage,pricing,casefile}.ts` | `src/platform/ledger/` |
+| `src/platform/shared/{json,clock}.ts` | `src/platform/shared/` |
+| `src/contracts/{entities,statuses}.ts` | `src/contracts/` |
+
+Dependency rule: ledger → shared/contracts, strictly downward. Upper layers may only import the facade `src/index.ts`.
+
+## Quick start — no install step
+
+Requires Node ≥ 22.18 (built-in type stripping + `node:sqlite`).
+
+```bash
+node bin/juli-ledger.ts demo /tmp/demo-ledger   # seed a demo ledger
+node bin/juli-ledger.ts ls    /tmp/demo-ledger   # list recent workflows
+node bin/juli-ledger.ts usage /tmp/demo-ledger --days 7
+node bin/juli-ledger.ts show  /tmp/demo-ledger <workflow-id>
+```
+
+Or from code:
+
+```ts
+import { createLedgerStore } from '@juli-os/ledger';
+const store = createLedgerStore('./ledger.db');   // opens + migrates in one call
+const wf = store.createWorkflow({ kind: 'case', title: 'First job' });
+store.createStep({ workflowId: wf.id, seq: 1, kind: 'agent', title: 'Do work' });
+```
+
+Run the test suite (zero npm install):
+
+```bash
+node --test "test/*.test.ts"
+```
+
+## Locale note
+
+Status display labels (`queued`/`running`/… rendered values) and pricing-tier notes in the data tables are currently `zh-CN`. These are **data values, not API surface** — an i18n pass is planned; the labels are shared with the (Chinese-language) production system this layer was peeled from. All README/CLI/API/error-comment surfaces are English.
+
+## This is a validation slice
+
+This package is the first empirical test of the **"layers you can peel off"** hypothesis (adopt at your altitude): standing alone, on a clean machine, with no node_modules, the ledger layer is fully usable. Verified green on macOS node 22 and a bare Linux box on node 24. L0 (execution substrate), L2 (artifacts), L4 (routing) follow the same recipe.
+
+## License
+
+Apache-2.0

package/dist/contracts/entities.d.ts

@@ -0,0 +1,64 @@
+import type { JsonRecord } from '../platform/shared/json.ts';
+export type WorkflowStatus = 'queued' | 'running' | 'completed' | 'failed' | 'cancelled' | 'rejected';
+export declare const TERMINAL_WORKFLOW_STATUSES: readonly WorkflowStatus[];
+export type StepStatus = 'pending' | 'running' | 'waiting_human' | 'completed' | 'failed' | 'cancelled' | 'skipped';
+export type StepKind = 'triage' | 'gate' | 'agent' | 'verify' | 'draft' | 'send' | 'llm' | 'share';
+export declare const STEP_KINDS: readonly StepKind[];
+export declare const AGENT_STEP_KINDS: readonly StepKind[];
+export declare const INSTRUCTABLE_STEP_KINDS: readonly StepKind[];
+export interface Workflow {
+    readonly id: string;
+    readonly parentId: string | null;
+    readonly kind: string;
+    readonly title: string;
+    readonly status: WorkflowStatus;
+    readonly session: string;
+    readonly project: string;
+    readonly path: string;
+    readonly threadId: string | null;
+    readonly meta: JsonRecord;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+}
+export interface Step {
+    readonly id: string;
+    readonly workflowId: string;
+    readonly seq: number;
+    readonly kind: StepKind;
+    readonly title: string;
+    readonly status: StepStatus;
+    readonly input: JsonRecord;
+    readonly output: JsonRecord;
+    readonly summary: string;
+    readonly updatedAt: string;
+    readonly startedAt: string;
+    readonly completedAt: string | null;
+}
+export interface LedgerEvent {
+    readonly id: number;
+    readonly entityType: 'workflow' | 'step' | 'judgment' | 'agent';
+    readonly entityId: string;
+    readonly type: string;
+    readonly payload: JsonRecord;
+    readonly ts: string;
+}
+export interface Run {
+    readonly id: string;
+    readonly workflowId: string;
+    readonly session: string;
+    readonly status: 'running' | 'idle' | 'completed' | 'failed';
+    readonly createdAt: string;
+}
+export interface Prompt {
+    readonly id: string;
+    readonly runId: string;
+    readonly content: string;
+    readonly status: 'submitted' | 'completed' | 'failed';
+    readonly createdAt: string;
+}
+export interface TaskView {
+    readonly taskId: string;
+    readonly title: string;
+    readonly status: WorkflowStatus;
+    readonly workflowIds: readonly string[];
+}

package/dist/contracts/statuses.d.ts

@@ -0,0 +1,34 @@
+import type { StepStatus, WorkflowStatus } from './entities.ts';
+export type StatusGroup = '进行中' | '等决定' | '终态';
+export interface StatusDef {
+    readonly key: string;
+    readonly label: string;
+    readonly group: StatusGroup;
+    readonly terminal: boolean;
+}
+export declare const STATUS_GROUP_OTHER = "\u5176\u4ED6";
+export type WorkflowStatusDef = StatusDef & {
+    readonly key: WorkflowStatus;
+};
+export type StepStatusDef = StatusDef & {
+    readonly key: StepStatus;
+};
+export declare const WORKFLOW_STATUSES: readonly StatusDef[];
+export declare const STEP_STATUSES: readonly StatusDef[];
+export declare const workflowStatusDef: (key: string) => StatusDef | undefined;
+export declare const stepStatusDef: (key: string) => StatusDef | undefined;
+export declare const statusLabelOf: (key: string) => string;
+export declare const ACTIVE_STEP_STATUSES: readonly string[];
+export declare const ACTIVE_WORKFLOW_STATUSES: readonly string[];
+export declare const SETTLED_STEP_STATUSES: readonly string[];
+export declare const SETTLED_WORKFLOW_STATUSES: readonly string[];
+export declare const TERMINAL_STEP_STATUSES: readonly string[];
+export declare const DEDUP_WINDOW_STATUSES: readonly string[];
+export declare const PRUNE_WORKFLOW_STATUSES: readonly string[];
+export declare const isActiveStepStatus: (s: string) => boolean;
+export declare const isActiveWorkflowStatus: (s: string) => boolean;
+export declare const isSettledStepStatus: (s: string) => boolean;
+export declare const isSettledWorkflowStatus: (s: string) => boolean;
+export declare const isTerminalStepStatus: (s: string) => boolean;
+export declare const isLiveNodeStatus: (s: string) => boolean;
+export declare const sqlInList: (keys: readonly string[]) => string;

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { createLedgerStore, type LifecycleStore } from './platform/ledger/store.ts';
+export type { Workflow, Step, WorkflowStatus, StepStatus, StepKind } from './contracts/entities.ts';
+export { createUsageStore, type UsageStore, type UsageStats } from './platform/ledger/usage.ts';
+export { priceUsage, findPrice, type UsageCost, type UsageRow } from './platform/ledger/pricing.ts';
+export { emptyCaseFile, parseCaseFile, serializeCaseFile, type CaseFileDoc, appendSection, appendExecution, appendDecision, appendReference, originalEmail, } from './platform/ledger/casefile.ts';
+export { rfc3339, systemClock, randomIds, type Clock, type IdGen } from './platform/shared/clock.ts';
+export { asRecord, safeParse, type JsonRecord, type JsonValue } from './platform/shared/json.ts';