@ariestools/aries-datalake-core 0.1.13

package/dist/node/types/DatalakeConfig.d.ts

@@ -0,0 +1,48 @@
+import type { DatalakeRegion } from './Region.ts';
+import type { DatalakeTier } from './Tier.ts';
+/**
+ * User-supplied configuration for provisioning a new datalake. All fields are
+ * optional except tier; the control plane applies defaults for the rest.
+ */
+export interface DatalakeConfig {
+    /** Payload schemas allowed for insert; empty array means all allowed. */
+    allowedSchemas?: string[];
+    /** Payload schemas disallowed for insert. */
+    disallowedSchemas?: string[];
+    /** Provisioned IOPS target. Ignored for the archive tier. */
+    iops?: number;
+    /**
+     * Per-datalake rate-limit overrides. When omitted, the data plane's
+     * default limits apply. Use this to tighten compliance-sensitive
+     * datalakes or relax a limit for a trusted internal tenant.
+     */
+    rateLimits?: RateLimitOverrides;
+    /** Deployment region. */
+    region?: DatalakeRegion;
+    /** Retention policy in days. `null` means keep forever. */
+    retentionDays?: number | null;
+    /** Provisioned capacity in bytes. Ignored for the archive tier. */
+    sizeBytes?: number;
+    /** Service tier (controls storage driver, IOPS ceiling, compute shape). */
+    tier: DatalakeTier;
+    /**
+     * Reserved. The archivist always recomputes `_hash` and `_dataHash` from
+     * payload bytes trustlessly, so this flag is a no-op. Kept on the type so
+     * older configs still parse; will be removed in a future major.
+     *
+     * @deprecated archivist is the trustless authority — no client-supplied
+     * hash is honored.
+     */
+    verifyHashes?: boolean;
+}
+export interface RateLimitOverrides {
+    /** Max anonymous requests per minute. */
+    anonymousPerMinute?: number;
+    /** Max authenticated requests per minute. */
+    authenticatedPerMinute?: number;
+    /**
+     * Burst multiplier (1 = no burst). Bucket capacity = perMinute * burstFactor.
+     */
+    burstFactor?: number;
+}
+//# sourceMappingURL=DatalakeConfig.d.ts.map

package/dist/node/types/DatalakeConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DatalakeConfig.d.ts","sourceRoot":"","sources":["../../../src/types/DatalakeConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAE7C;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,yEAAyE;IACzE,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;IACzB,6CAA6C;IAC7C,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;OAIG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAC/B,yBAAyB;IACzB,MAAM,CAAC,EAAE,cAAc,CAAA;IACvB,2DAA2D;IAC3D,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,mEAAmE;IACnE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,2EAA2E;IAC3E,IAAI,EAAE,YAAY,CAAA;IAClB;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,yCAAyC;IACzC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,6CAA6C;IAC7C,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB"}

package/dist/node/types/DatalakeDescriptor.d.ts

@@ -0,0 +1,38 @@
+import type { AclEntry } from './AclEntry.ts';
+import type { DatalakeConfig } from './DatalakeConfig.ts';
+import type { DatalakeStatus } from './Status.ts';
+/**
+ * Full server-side view of a provisioned datalake. Returned by
+ * `DatalakeClient.describe`, `DatalakeClient.list`, and `DatalakeClient.create`.
+ */
+export interface DatalakeDescriptor {
+    /** Access grants. Owner is implicit and not listed here. */
+    acl: AclEntry[];
+    /** Requested configuration. */
+    config: DatalakeConfig;
+    /** ISO-8601 timestamps. */
+    createdAt: string;
+    /** Human-readable message when status === 'error'. */
+    errorMessage?: string;
+    /** Opaque server-assigned id. */
+    id: string;
+    /** Human-friendly name scoped to the owner. */
+    name: string;
+    /** User id of the owner. */
+    ownerId: string;
+    /** Current lifecycle state. */
+    status: DatalakeStatus;
+    updatedAt: string;
+    /** Public HTTPS URL of the RestDataLake endpoint (set once status === 'ready'). */
+    url?: string;
+    /** Current usage, refreshed periodically by the control plane. */
+    usage?: DatalakeUsage;
+}
+export interface DatalakeUsage {
+    bytesStored: number;
+    bytesStoredLimit: number;
+    payloadCount: number;
+    readsLast24h: number;
+    writesLast24h: number;
+}
+//# sourceMappingURL=DatalakeDescriptor.d.ts.map

package/dist/node/types/DatalakeDescriptor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DatalakeDescriptor.d.ts","sourceRoot":"","sources":["../../../src/types/DatalakeDescriptor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAC7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEjD;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,4DAA4D;IAC5D,GAAG,EAAE,QAAQ,EAAE,CAAA;IACf,+BAA+B;IAC/B,MAAM,EAAE,cAAc,CAAA;IACtB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,sDAAsD;IACtD,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAA;IACZ,4BAA4B;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,+BAA+B;IAC/B,MAAM,EAAE,cAAc,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,mFAAmF;IACnF,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,kEAAkE;IAClE,KAAK,CAAC,EAAE,aAAa,CAAA;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,MAAM,CAAA;IACxB,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;CACtB"}

package/dist/node/types/Payload.d.ts

@@ -0,0 +1,75 @@
+import type { Payload, WithStorageMeta } from '@xyo-network/sdk-protocol/payload-model';
+/**
+ * Re-export the canonical XYO `Payload` and `WithStorageMeta` types for the
+ * Node data plane. The `/browser` entry point exposes an independent JSON
+ * wire contract so browser consumers do not inherit the SDK declaration graph.
+ *
+ * `Payload` is generic — extra fields require parameterising it as
+ * `Payload<{ foo: string }>`. Callers that just receive raw JSON should
+ * widen via `as unknown as Payload[]` at the parse boundary.
+ */
+export type { Payload, WithStorageMeta } from '@xyo-network/sdk-protocol/payload-model';
+/**
+ * A payload as it leaves the data plane after archivist processing.
+ */
+export type StoredPayload = WithStorageMeta<Payload>;
+/**
+ * Options for paginating through payloads on a datalake. The cursor is the
+ * `_sequence` of the last payload returned (archivist-canonical).
+ */
+export interface NextPayloadsOptions {
+    /** Resume after this sequence (exclusive). */
+    cursor?: string;
+    /** Maximum payloads to return. Server caps this. */
+    limit?: number;
+    /** Sort direction by archivist-assigned sequence. */
+    order?: 'asc' | 'desc';
+    /** Restrict to payloads whose schema matches one of these. */
+    schemas?: string[];
+}
+/**
+ * Response body for the iterate endpoint. Mirrors the XYO archivist
+ * middleware shape (bare array); the next cursor is delivered via the
+ * `X-Datalake-Next-Cursor` response header.
+ */
+export type NextPayloadsResponse = StoredPayload[];
+/**
+ * Request body for the insert endpoint. A single payload or an array,
+ * matching the XYO archivist middleware contract.
+ */
+export type InsertPayloadsBody = Payload | Payload[];
+/**
+ * Response body for the insert endpoint. The archivist-stamped payloads
+ * that were stored, in order. Policy-rejected hashes and duplicate counts
+ * are delivered via response headers (`X-Datalake-Rejected`,
+ * `X-Datalake-Duplicates`).
+ */
+export type InsertPayloadsResponse = StoredPayload[];
+/**
+ * Datalake-specific extras that accompany an insert response. Read from
+ * response headers by `RestPayloadsClient`; a generic archivist client can
+ * ignore them.
+ */
+export interface DatalakeInsertSummary {
+    /** Payloads in the request whose hash already existed in the datalake. */
+    duplicates: number;
+    /** Archivist-computed `_hash` values that were rejected by schema policy. */
+    rejected: string[];
+}
+/**
+ * Combined result returned by the `PayloadsClient.insert()` method. Pairs
+ * the bare archivist response array with the datalake-specific extras.
+ */
+export interface InsertPayloadsResult {
+    inserted: StoredPayload[];
+    summary: DatalakeInsertSummary;
+}
+/**
+ * Combined result returned by the `PayloadsClient.next()` method. Pairs the
+ * bare archivist response array with the next-page cursor (when present).
+ */
+export interface NextPayloadsResult {
+    nextCursor?: string;
+    payloads: StoredPayload[];
+}
+//# sourceMappingURL=Payload.d.ts.map

package/dist/node/types/Payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/types/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAA;AAEvF;;;;;;;;GAQG;AACH,YAAY,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAA;AAEvF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,eAAe,CAAC,OAAO,CAAC,CAAA;AAEpD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,qDAAqD;IACrD,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;IACtB,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,aAAa,EAAE,CAAA;AAElD;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,OAAO,EAAE,CAAA;AAEpD;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG,aAAa,EAAE,CAAA;AAEpD;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,0EAA0E;IAC1E,UAAU,EAAE,MAAM,CAAA;IAClB,6EAA6E;IAC7E,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,aAAa,EAAE,CAAA;IACzB,OAAO,EAAE,qBAAqB,CAAA;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,aAAa,EAAE,CAAA;CAC1B"}

package/dist/node/types/Principal.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Access-control role granted to a principal on a datalake.
+ * Maps 1:1 to XL1's DataLakeViewer (read) and DataLakeRunner (read/write) monikers.
+ */
+export type DatalakeRole = 'viewer' | 'runner';
+/**
+ * A principal identifier. Either a control-plane user id, or the reserved
+ * value `PUBLIC_PRINCIPAL` (`'public'`) which opens access to unauthenticated
+ * callers at the granted role.
+ */
+export type DatalakePrincipal = string;
+export declare const PUBLIC_PRINCIPAL = "public";
+/**
+ * Type guard for the reserved `public` principal.
+ */
+export declare function isPublicPrincipal(principal: DatalakePrincipal): boolean;
+//# sourceMappingURL=Principal.d.ts.map

package/dist/node/types/Principal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Principal.d.ts","sourceRoot":"","sources":["../../../src/types/Principal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE9C;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAA;AAEtC,eAAO,MAAM,gBAAgB,WAAW,CAAA;AAExC;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,iBAAiB,GAAG,OAAO,CAEvE"}

package/dist/node/types/Region.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Cloud regions where datalakes can be provisioned. Starts with AWS us-west-2;
+ * additional regions are added as the control plane expands.
+ */
+export type DatalakeRegion = 'us-west-2' | 'us-east-1' | 'eu-west-1';
+export declare const DATALAKE_REGIONS: readonly DatalakeRegion[];
+export declare const DEFAULT_REGION: DatalakeRegion;
+//# sourceMappingURL=Region.d.ts.map

package/dist/node/types/Region.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Region.d.ts","sourceRoot":"","sources":["../../../src/types/Region.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,CAAA;AAEpE,eAAO,MAAM,gBAAgB,EAAE,SAAS,cAAc,EAAqD,CAAA;AAE3G,eAAO,MAAM,cAAc,EAAE,cAA4B,CAAA"}

package/dist/node/types/Scope.d.ts

@@ -0,0 +1,17 @@
+/** Audience used by browser wallet JWTs for control-plane operations. */
+export declare const DATALAKE_CONTROL_AUDIENCE = "aries-datalake-control";
+/** Schema required on every wallet sign-in JWT accepted by Aries. */
+export declare const DATALAKE_WALLET_JWT_SCHEMA = "network.xyo.auth.signin";
+/** Browser operations intentionally exposed by the datalake control plane. */
+export declare const DATALAKE_CONTROL_OPERATIONS: readonly ["datalake:create", "datalake:describe", "datalake:list"];
+/** Browser operations intentionally exposed by the datalake data plane. */
+export declare const DATALAKE_DATA_OPERATIONS: readonly ["payload:append", "payload:read", "usage:read"];
+export type DatalakeControlOperation = typeof DATALAKE_CONTROL_OPERATIONS[number];
+export type DatalakeDataOperation = typeof DATALAKE_DATA_OPERATIONS[number];
+export type DatalakeOperation = DatalakeControlOperation | DatalakeDataOperation;
+/** Canonical complete scope strings used when requesting browser wallet approval. */
+export declare const DATALAKE_CONTROL_SCOPE: string;
+export declare const DATALAKE_DATA_SCOPE: string;
+export declare function isDatalakeControlOperation(value: string): value is DatalakeControlOperation;
+export declare function isDatalakeDataOperation(value: string): value is DatalakeDataOperation;
+//# sourceMappingURL=Scope.d.ts.map

package/dist/node/types/Scope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Scope.d.ts","sourceRoot":"","sources":["../../../src/types/Scope.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,eAAO,MAAM,yBAAyB,2BAA2B,CAAA;AAEjE,qEAAqE;AACrE,eAAO,MAAM,0BAA0B,4BAA4B,CAAA;AAEnE,8EAA8E;AAC9E,eAAO,MAAM,2BAA2B,oEAI9B,CAAA;AAEV,2EAA2E;AAC3E,eAAO,MAAM,wBAAwB,2DAI3B,CAAA;AAEV,MAAM,MAAM,wBAAwB,GAAG,OAAO,2BAA2B,CAAC,MAAM,CAAC,CAAA;AACjF,MAAM,MAAM,qBAAqB,GAAG,OAAO,wBAAwB,CAAC,MAAM,CAAC,CAAA;AAC3E,MAAM,MAAM,iBAAiB,GAAG,wBAAwB,GAAG,qBAAqB,CAAA;AAEhF,qFAAqF;AACrF,eAAO,MAAM,sBAAsB,QAAwC,CAAA;AAC3E,eAAO,MAAM,mBAAmB,QAAqC,CAAA;AAErE,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,wBAAwB,CAE3F;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,qBAAqB,CAErF"}

package/dist/node/types/Status.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Lifecycle state of a datalake on the control plane. The Provisioner worker
+ * transitions a datalake through these states; the CLI surfaces them via
+ * `aries datalake describe`.
+ */
+export type DatalakeStatus = 'pending' | 'provisioning' | 'ready' | 'resizing' | 'deprovisioning' | 'deleted' | 'error';
+//# sourceMappingURL=Status.d.ts.map

package/dist/node/types/Status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Status.d.ts","sourceRoot":"","sources":["../../../src/types/Status.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACpB,SAAS,GACT,cAAc,GACd,OAAO,GACP,UAAU,GACV,gBAAgB,GAChB,SAAS,GACT,OAAO,CAAA"}

package/dist/node/types/Tier.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Datalake service tiers. Each tier maps to a storage driver + resource profile
+ * on the control plane: small/medium use the shared hot pool, large gets a
+ * dedicated RestDataLake pod, archive uses the S3 + DynamoDB cold driver.
+ */
+export type DatalakeTier = 'small' | 'medium' | 'large' | 'archive';
+export declare const DATALAKE_TIERS: readonly DatalakeTier[];
+//# sourceMappingURL=Tier.d.ts.map

package/dist/node/types/Tier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tier.d.ts","sourceRoot":"","sources":["../../../src/types/Tier.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAA;AAEnE,eAAO,MAAM,cAAc,EAAE,SAAS,YAAY,EAAqD,CAAA"}

package/dist/node/types/Token.d.ts

@@ -0,0 +1,18 @@
+import type { DatalakeRole } from './Principal.ts';
+/**
+ * A scoped token minted for a single datalake + role. Safe to embed in SDKs
+ * or CI. Expires; refresh via the control plane.
+ */
+export interface DatalakeToken {
+    /** Datalake id the token is scoped to. */
+    datalakeId: string;
+    /** ISO-8601 expiration. */
+    expiresAt: string;
+    /** Granted role. */
+    role: DatalakeRole;
+    /** The raw JWT string. */
+    token: string;
+    /** The URL the token should be used against. */
+    url: string;
+}
+//# sourceMappingURL=Token.d.ts.map

package/dist/node/types/Token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Token.d.ts","sourceRoot":"","sources":["../../../src/types/Token.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAElD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,0CAA0C;IAC1C,UAAU,EAAE,MAAM,CAAA;IAClB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,oBAAoB;IACpB,IAAI,EAAE,YAAY,CAAA;IAClB,0BAA0B;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,gDAAgD;IAChD,GAAG,EAAE,MAAM,CAAA;CACZ"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@ariestools/aries-datalake-core",
+  "version": "0.1.13",
+  "description": "Shared types and contracts for Aries on-demand XL1 datalake provisioning",
+  "keywords": [
+    "xylabs",
+    "ariestools",
+    "datalake",
+    "xl1",
+    "typescript"
+  ],
+  "homepage": "https://xylabs.com",
+  "bugs": {
+    "url": "git+https://github.com/xylabs/ariestools/issues",
+    "email": "support@xylabs.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xylabs/ariestools.git"
+  },
+  "license": "LGPL-3.0-only",
+  "author": {
+    "name": "XY Labs Development Team",
+    "email": "support@xylabs.com",
+    "url": "https://xylabs.com"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/node/index.d.ts",
+      "default": "./dist/node/index.mjs"
+    },
+    "./browser": {
+      "types": "./dist/browser/browser.d.ts",
+      "default": "./dist/browser/browser.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "devDependencies": {
+    "@ariestools/toolchain": "~8.7.21",
+    "@ariestools/tsconfig": "~8.7.21",
+    "@types/node": "~26.1.1",
+    "@xyo-network/sdk-protocol": "~7.2.2",
+    "typescript": "~6.0.3",
+    "vite": "~8.1.5",
+    "vitest": "~4.1.10"
+  },
+  "peerDependencies": {
+    "@xyo-network/sdk-protocol": "^7.2"
+  },
+  "engines": {
+    "node": ">=18.17.1"
+  },
+  "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "package-compile": "package-compile-only && node ../../scripts/pruneBrowserDeclarations.mjs dist/browser/browser.d.ts"
+  }
+}