@artkit-ai/core 0.0.0-stage → 0.2.0

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,65 @@
-# Temporary Holding Version
+# @artkit-ai/core
 
-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 runtime-neutral heart of artkit: artifact envelope, kind contract and registry, the atomic operation engine, versioning with automatic rebase, migrations, diff, lint and projection helpers, the error catalog, store/asset/event contracts and the high-level artifact service.
+
+Its only dependency is `zod`. It runs in browsers, Node 22+, edge runtimes and workers (no DOM, no Node APIs).
+
+```bash
+npm install @artkit-ai/core
+```
+
+## Usage
+
+```ts
+import { createArtifactService, createMemoryStore, createRegistry } from '@artkit-ai/core';
+import { documentKind } from '@artkit-ai/kind-document';
+
+const registry = createRegistry({ kinds: [documentKind] });
+const service = createArtifactService({
+  registry,
+  store: createMemoryStore(),
+  authorize: (action, artifact, scope) => scope.workspaceId === 'acme',
+  locale: 'pt-BR',
+});
+
+const scope = { workspaceId: 'acme', actor: { type: 'agent', id: 'agent-proposals' } } as const;
+const { artifact } = await service.create(scope, {
+  kind: 'document',
+  title: 'Proposta técnica',
+  input: { format: 'markdown', source: '# Proposta\n\n## Escopo\n\nPortal de fornecedores.' },
+});
+
+const result = await service.apply(scope, {
+  artifactId: artifact.id,
+  baseVersion: artifact.version,
+  operations: [{ op: 'set_title', title: 'Proposta técnica v2' }],
+});
+console.log(result.version, result.diff, result.lint);
+```
+
+## What is inside
+
+| Area          | API                                                                                                                                                                                                        |
+| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Envelope      | `Artifact`, `envelopeSchema`, statuses and lifecycle transitions                                                                                                                                           |
+| Kinds         | `ArtifactKind`, `defineKind`, `createRegistry` (kinds, themes, exporters, limits)                                                                                                                          |
+| Engine        | `applyOperations` (validate → clone → apply → derive → revalidate → limits → diff → lint, all or nothing), `prepareContent`, envelope operations `set_title`, `set_theme`, `set_locale`, `replace_content` |
+| Service       | `createArtifactService`: authorization hook, `baseVersion` with automatic rebase or `VERSION_CONFLICT`, idempotency keys, locks, approval policy, history and restore, export orchestration with timeout   |
+| Projection    | `projectItems`, `paginate` (token budget and cursor), `selectRange`, `delimitProjection`                                                                                                                   |
+| Diff          | `diffCollection` (added, removed, changed, moved), `diffFields`                                                                                                                                            |
+| Errors        | `ArtifactError`, `toModelError` (never leaks stack traces), pt-BR and English catalogs                                                                                                                     |
+| Security      | `sanitizeDeep` (control characters, NFC), `linkSchema`, `checkAsset` (magic-byte MIME sniffing, size, domains), `sanitizeSvg`                                                                              |
+| Schemas       | `toJsonSchema` with `default`, `strict` and `compact` profiles; `stripNulls`                                                                                                                               |
+| Stores        | `ArtifactStore`, `AssetStore` contracts; `createMemoryStore`, `createMemoryAssetStore` (reference adapters)                                                                                                |
+| UI contracts  | `RenderContext`, `EditorBindings`, `themeCssVariables` (shared by renderers, editors and `@artkit-ai/react`)                                                                                               |
+| Events & logs | `createEventBus`, `Logger` (metadata only), metric hooks                                                                                                                                                   |
+
+`@artkit-ai/core/testing` exports `defineStoreContractTests` (every store adapter must pass it) and `defineKindConformanceTests` (every kind, native or third-party).
+
+## Notes
+
+- `apply` is pure and deterministic: no clock, network or randomness. Replays always produce the same content.
+- The memory store lives here (not in `@artkit-ai/node`) so it also works in the browser playground and in edge runtimes; `@artkit-ai/node` re-exports it.
+- `INTERNAL_ERROR` extends the spec's error catalog for unexpected failures, so details never reach the model.
+
+License: Apache-2.0.

package/dist/adapter.d.ts

@@ -0,0 +1,119 @@
+import type { z } from 'zod';
+import type { ErrorIssue } from './errors.js';
+import type { Theme } from './theme.js';
+/** Contract every native format implements (spec §8). Adapters own all knowledge about their format. */
+export interface FormatAdapter<Content = unknown, Operation = unknown> {
+    /** Format name stored in the envelope: `markdown`, `univer-sheet`, `openui`. */
+    format: string;
+    /** Version of the native format or third-party library the content is written with (e.g. `univer-sheet@0.x`). */
+    formatVersion: string;
+    /** Format versions this adapter can read; `formatVersion` is the one it writes. */
+    readableVersions: string[];
+    label: string;
+    /** Smallest valid content, used when an artifact is created from operations only. */
+    empty(): Content;
+    /** Validates content (already parsed from the store or from the model). Throws nothing; reports issues. */
+    validate(content: unknown, ctx: AdapterContext): ValidationResult<Content>;
+    operationSchema: z.ZodType<Operation>;
+    /**
+     * Applies a run of content operations on a draft. The draft is a private copy; mutations are kept only when the
+     * whole batch succeeds. Must not read the clock, the network or randomness.
+     */
+    apply(content: Content, operations: Operation[], ctx: AdapterContext): Promise<ApplyResult<Content>>;
+    /** Compact reading for the model (outline, section, range, full), with budget and cursor. */
+    read(content: Content, request: ReadRequest): ReadResult;
+    diff(before: Content, after: Content, locale?: string): ChangeSummary[];
+    lint(content: Content, ctx: LintContext): LintIssue[];
+    /** Best-effort preview while the model streams; drops incomplete trailing items. Returns undefined when unusable. */
+    parsePartial(raw: string): Content | undefined;
+    migrations: FormatMigration[];
+    /** Counters checked against `limits` (same keys as `measure`). */
+    limits: FormatLimits;
+    measure?(content: Content): Record<string, number>;
+    instructions: FormatInstructions;
+}
+export interface AdapterContext {
+    locale: string;
+    theme: Theme;
+    /** Fails the batch with `OPERATION_FAILED`; the message and hint are written for the model to fix the call. */
+    fail(message: string, options?: {
+        hint?: string;
+        path?: string;
+    }): never;
+}
+export type ValidationResult<Content> = {
+    ok: true;
+    content: Content;
+} | {
+    ok: false;
+    issues: ErrorIssue[];
+};
+export interface ApplyResult<Content> {
+    content: Content;
+    /** Anchors, declarations, ranges or sheets created by the batch (e.g. `escopo`, `kpi1`, `Resumo!A1:D3`). */
+    createdRefs: string[];
+    warnings: LintIssue[];
+}
+export type ReadMode = 'outline' | 'section' | 'statements' | 'range' | 'full';
+export interface ReadRequest {
+    mode: ReadMode;
+    /** Format-specific selection: anchors, A1 range, declaration names. */
+    range?: string;
+    /** Token budget; text is cut at an item boundary and a cursor is returned. */
+    maxTokens?: number;
+    cursor?: string;
+    locale: string;
+    charsPerToken?: number;
+}
+export interface ReadResult {
+    text: string;
+    truncated: boolean;
+    /** Present when truncated: pass it back to continue reading. */
+    cursor?: string;
+}
+export type LintSeverity = 'warning' | 'info';
+export interface LintIssue {
+    code: string;
+    severity: LintSeverity;
+    /** `section:cronograma`, `cell:Resumo!D14`, `slide:cronograma`, `node:api`… */
+    target: string;
+    message: string;
+    hint?: string;
+}
+export interface LintContext {
+    locale: string;
+    theme: Theme;
+}
+export type ChangeType = 'added' | 'removed' | 'changed' | 'moved';
+export interface ChangeSummary {
+    type: ChangeType;
+    /** Same vocabulary as lint targets; the core compares these to detect rebase conflicts. */
+    target: string;
+    summary: string;
+}
+export interface FormatMigration {
+    from: string;
+    to: string;
+    migrate(content: unknown): unknown;
+}
+export type FormatLimits = Record<string, number>;
+export interface FormatExample {
+    title: string;
+    operations?: unknown[];
+    content?: unknown;
+}
+export interface FormatInstructions {
+    /** What the format is and when to use it. */
+    summary: string;
+    /** Short, verifiable rules. */
+    rules: string[];
+    examples: FormatExample[];
+}
+export type AnyFormatAdapter = FormatAdapter<any, any>;
+export declare class FormatDefinitionError extends Error {
+    constructor(format: string, problem: string);
+}
+/** Checks an adapter's shape. The registry runs it on `register`; third-party adapters can call it directly. */
+export declare function defineFormat<Content, Operation>(adapter: FormatAdapter<Content, Operation>): FormatAdapter<Content, Operation>;
+export declare function assertFormatContract(adapter: AnyFormatAdapter): void;
+//# sourceMappingURL=adapter.d.ts.map

package/dist/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC,wGAAwG;AACxG,MAAM,WAAW,aAAa,CAAC,OAAO,GAAG,OAAO,EAAE,SAAS,GAAG,OAAO;IACnE,gFAAgF;IAChF,MAAM,EAAE,MAAM,CAAC;IACf,iHAAiH;IACjH,aAAa,EAAE,MAAM,CAAC;IACtB,mFAAmF;IACnF,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;IAEd,qFAAqF;IACrF,KAAK,IAAI,OAAO,CAAC;IACjB,2GAA2G;IAC3G,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC3E,eAAe,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACtC;;;OAGG;IACH,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;IAErG,6FAA6F;IAC7F,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,GAAG,UAAU,CAAC;IACzD,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,aAAa,EAAE,CAAC;IACxE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,WAAW,GAAG,SAAS,EAAE,CAAC;IACtD,qHAAqH;IACrH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IAE/C,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,kEAAkE;IAClE,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnD,YAAY,EAAE,kBAAkB,CAAC;CAClC;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;IACb,+GAA+G;IAC/G,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,KAAK,CAAC;CAC1E;AAED,MAAM,MAAM,gBAAgB,CAAC,OAAO,IAAI;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,UAAU,EAAE,CAAA;CAAE,CAAC;AAE7G,MAAM,WAAW,WAAW,CAAC,OAAO;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,4GAA4G;IAC5G,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,QAAQ,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,MAAM,MAAM,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,OAAO,GAAG,MAAM,CAAC;AAE/E,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,CAAC;IACf,uEAAuE;IACvE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,MAAM,CAAC;AAE9C,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,YAAY,CAAC;IACvB,+EAA+E;IAC/E,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd;AAED,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;AAEnE,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,UAAU,CAAC;IACjB,2FAA2F;IAC3F,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;CACpC;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAElD,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B;AAGD,MAAM,MAAM,gBAAgB,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAEvD,qBAAa,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAG1C;CACF;AAKD,gHAAgH;AAChH,wBAAgB,YAAY,CAAC,OAAO,EAAE,SAAS,EAC7C,OAAO,EAAE,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC,GACzC,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC,CAGnC;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAoCpE"}

package/dist/adapter.js

@@ -0,0 +1,45 @@
+export class FormatDefinitionError extends Error {
+    constructor(format, problem) {
+        super(`Invalid format "${format}": ${problem}`);
+        this.name = 'FormatDefinitionError';
+    }
+}
+const FORMAT_NAME = /^[a-z][a-z0-9-]{0,63}$/;
+const VERSION_NAME = /^[a-z0-9][a-z0-9.+@-]{0,63}$/i;
+/** Checks an adapter's shape. The registry runs it on `register`; third-party adapters can call it directly. */
+export function defineFormat(adapter) {
+    assertFormatContract(adapter);
+    return adapter;
+}
+export function assertFormatContract(adapter) {
+    const name = typeof adapter?.format === 'string' ? adapter.format : '<unnamed>';
+    if (!FORMAT_NAME.test(name))
+        throw new FormatDefinitionError(name, 'format must match /^[a-z][a-z0-9-]{0,63}$/');
+    if (typeof adapter.formatVersion !== 'string' || !VERSION_NAME.test(adapter.formatVersion)) {
+        throw new FormatDefinitionError(name, 'formatVersion must be a non-empty version string');
+    }
+    if (!Array.isArray(adapter.readableVersions) || !adapter.readableVersions.includes(adapter.formatVersion)) {
+        throw new FormatDefinitionError(name, 'readableVersions must include formatVersion');
+    }
+    if (!(adapter.operationSchema && typeof adapter.operationSchema.safeParse === 'function')) {
+        throw new FormatDefinitionError(name, 'operationSchema must be a zod schema');
+    }
+    for (const fn of ['empty', 'validate', 'apply', 'read', 'diff', 'lint', 'parsePartial']) {
+        if (typeof adapter[fn] !== 'function')
+            throw new FormatDefinitionError(name, `${fn} must be a function`);
+    }
+    if (!Array.isArray(adapter.migrations))
+        throw new FormatDefinitionError(name, 'migrations must be an array');
+    for (const migration of adapter.migrations) {
+        if (!adapter.readableVersions.includes(migration.from) ||
+            !adapter.readableVersions.includes(migration.to)) {
+            throw new FormatDefinitionError(name, `migration ${migration.from}→${migration.to} must use readable versions`);
+        }
+    }
+    if (!adapter.instructions ||
+        typeof adapter.instructions.summary !== 'string' ||
+        !Array.isArray(adapter.instructions.rules)) {
+        throw new FormatDefinitionError(name, 'instructions need summary, rules and examples');
+    }
+}
+//# sourceMappingURL=adapter.js.map

package/dist/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AA6HA,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,MAAc,EAAE,OAAe;QACzC,KAAK,CAAC,mBAAmB,MAAM,MAAM,OAAO,EAAE,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACtC,CAAC;CACF;AAED,MAAM,WAAW,GAAG,wBAAwB,CAAC;AAC7C,MAAM,YAAY,GAAG,+BAA+B,CAAC;AAErD,gHAAgH;AAChH,MAAM,UAAU,YAAY,CAC1B,OAA0C;IAE1C,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAC9B,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,OAAyB;IAC5D,MAAM,IAAI,GAAG,OAAO,OAAO,EAAE,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC;IAChF,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;QACzB,MAAM,IAAI,qBAAqB,CAAC,IAAI,EAAE,4CAA4C,CAAC,CAAC;IACtF,IAAI,OAAO,OAAO,CAAC,aAAa,KAAK,QAAQ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;QAC3F,MAAM,IAAI,qBAAqB,CAAC,IAAI,EAAE,kDAAkD,CAAC,CAAC;IAC5F,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;QAC1G,MAAM,IAAI,qBAAqB,CAAC,IAAI,EAAE,6CAA6C,CAAC,CAAC;IACvF,CAAC;IACD,IAAI,CAAC,CAAC,OAAO,CAAC,eAAe,IAAI,OAAO,OAAO,CAAC,eAAe,CAAC,SAAS,KAAK,UAAU,CAAC,EAAE,CAAC;QAC1F,MAAM,IAAI,qBAAqB,CAAC,IAAI,EAAE,sCAAsC,CAAC,CAAC;IAChF,CAAC;IACD,KAAK,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,CAAU,EAAE,CAAC;QACjG,IAAI,OAAO,OAAO,CAAC,EAAE,CAAC,KAAK,UAAU;YAAE,MAAM,IAAI,qBAAqB,CAAC,IAAI,EAAE,GAAG,EAAE,qBAAqB,CAAC,CAAC;IAC3G,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;QACpC,MAAM,IAAI,qBAAqB,CAAC,IAAI,EAAE,6BAA6B,CAAC,CAAC;IACvE,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QAC3C,IACE,CAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC;YAClD,CAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,EAChD,CAAC;YACD,MAAM,IAAI,qBAAqB,CAC7B,IAAI,EACJ,aAAa,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,EAAE,6BAA6B,CACzE,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IACE,CAAC,OAAO,CAAC,YAAY;QACrB,OAAO,OAAO,CAAC,YAAY,CAAC,OAAO,KAAK,QAAQ;QAChD,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,EAC1C,CAAC;QACD,MAAM,IAAI,qBAAqB,CAAC,IAAI,EAAE,+CAA+C,CAAC,CAAC;IACzF,CAAC;AACH,CAAC"}

package/dist/assets.d.ts

@@ -0,0 +1,62 @@
+import { z } from 'zod';
+export declare const ASSET_REF_PATTERN: RegExp;
+export declare const assetRefSchema: z.ZodString;
+export type AssetRef = string;
+export declare function assetIdFromRef(ref: AssetRef): string;
+export interface AssetMeta {
+    mimeType: string;
+    filename?: string;
+    /** External URL the bytes came from, checked against the allowed domains. */
+    sourceUrl?: string;
+    /**
+     * `upload` (default): bytes from users or models, validated by magic bytes and the MIME allowlist.
+     * `generated`: files produced by artkit's own exporters (docx, xlsx, pptx…); only the size limit applies,
+     * since their type is known and they are never rendered inline from the asset store.
+     */
+    origin?: 'upload' | 'generated';
+}
+export interface StoredAssetInfo {
+    ref: AssetRef;
+    mimeType: string;
+    size: number;
+    /** SHA-256 hex of the stored bytes. */
+    hash: string;
+    filename?: string;
+}
+export interface ResolvedAsset {
+    bytes: Uint8Array;
+    mimeType: string;
+}
+/** What exporters and renderers use to read assets; implemented on top of an AssetStore. */
+export interface AssetResolver {
+    resolve(ref: AssetRef): Promise<ResolvedAsset>;
+}
+export declare const DEFAULT_ALLOWED_MIME_TYPES: readonly ['image/png', 'image/jpeg', 'image/webp', 'image/gif', 'image/svg+xml'];
+export interface AssetPolicy {
+    allowedMimeTypes: readonly string[];
+    maxBytes: number;
+    /** Size limit for files generated by exporters (`origin: 'generated'`); defaults to `maxBytes`. */
+    maxGeneratedBytes?: number;
+    /** Domains accepted for external URLs. Empty means external URLs are refused (spec §6.5). */
+    allowedDomains: readonly string[];
+}
+export declare const defaultAssetPolicy: AssetPolicy;
+/** Detects the real MIME type from magic bytes; never trusts the declared one alone. */
+export declare function sniffMimeType(bytes: Uint8Array): string | undefined;
+/**
+ * Sanitizes SVG bytes: removes scripts, foreign objects, entities, event handlers, javascript: URLs and
+ * external references. Returns undefined when the result does not look like an SVG.
+ */
+export declare function sanitizeSvg(svg: string): string | undefined;
+export interface CheckedAsset {
+    bytes: Uint8Array;
+    mimeType: string;
+}
+/** Validates bytes and metadata against the policy. Throws `ASSET_REJECTED` with the reason. */
+export declare function checkAsset(bytes: Uint8Array, meta: AssetMeta, policy?: AssetPolicy, locale?: string): CheckedAsset;
+export declare function isAllowedUrl(url: string, allowedDomains: readonly string[]): boolean;
+/** SHA-256 hex digest using Web Crypto (available in browsers, Node 22, edge and workers). */
+export declare function sha256Hex(bytes: Uint8Array): Promise<string>;
+/** Encodes bytes as a data URL (used by headless render, which blocks the network). */
+export declare function toDataUrl(bytes: Uint8Array, mimeType: string): string;
+//# sourceMappingURL=assets.d.ts.map

package/dist/assets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../src/assets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,eAAO,MAAM,iBAAiB,QAAiD,CAAC;AAEhF,eAAO,MAAM,cAAc,aAG0D,CAAC;AAEtF,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,wBAAgB,cAAc,CAAC,GAAG,EAAE,QAAQ,GAAG,MAAM,CAEpD;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6EAA6E;IAC7E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,QAAQ,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,UAAU,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,4FAA4F;AAC5F,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CAChD;AAED,eAAO,MAAM,0BAA0B,YACrC,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,eAAe,CACP,CAAC;AAEX,MAAM,WAAW,WAAW;IAC1B,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,mGAAmG;IACnG,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,6FAA6F;IAC7F,cAAc,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED,eAAO,MAAM,kBAAkB,EAAE,WAKhC,CAAC;AAEF,wFAAwF;AACxF,wBAAgB,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAsBnE;AAWD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAa3D;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,UAAU,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CACxB,KAAK,EAAE,UAAU,EACjB,IAAI,EAAE,SAAS,EACf,MAAM,GAAE,WAAgC,EACxC,MAAM,CAAC,EAAE,MAAM,GACd,YAAY,CAgCd;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAapF;AAED,8FAA8F;AAC9F,wBAAsB,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAGlE;AAED,uFAAuF;AACvF,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAKrE"}